Class Cluster

Client for the official Redis Cluster

Hierarchy

Commander
EventEmitter
Transaction
- Cluster

Index

Constructors

constructor

new Cluster(startupNodes: ClusterNode[], options?: ClusterOptions): Cluster
Creates an instance of Cluster.
Parameters
- startupNodes: ClusterNode[]
- options: ClusterOptions = {}
Returns Cluster
Overrides Commander.constructor
- Defined in cluster/index.ts:120

Properties

options

options: ClusterOptions

slots

slots: string[][] = []

status

status: ClusterStatus

Accessors

autoPipelineQueueSize

get autoPipelineQueueSize(): number
Get the number of commands queued in automatic pipelines.

This is not available (and returns 0) until the cluster is connected and slots information have been received.

Returns number
- Defined in cluster/index.ts:401

Methods

acl

acl(subcommand: "CAT", callback?: Callback<unknown>): Promise<unknown>
Lists the ACL categories, or the commands inside a category.
- group: server
- complexity: O(1) since the categories and commands are a fixed set.
- since: 6.0.0
Parameters
- subcommand: "CAT"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.acl
- Defined in utils/RedisCommander.ts:87
acl(
    subcommand: "CAT",
    category: string | Buffer,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "CAT"
- category: string | Buffer
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.acl
- Defined in utils/RedisCommander.ts:91
acl(
    ...args: [
        subcommand: "DELUSER",
        ...usernames: (string | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Deletes ACL users, and terminates their connections.
- group: server
- complexity: O(1) amortized time considering the typical user.
- since: 6.0.0
Parameters
- ...args: [
      subcommand: "DELUSER",
      ...usernames: (string | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.acl
- Defined in utils/RedisCommander.ts:103
acl(
...args: [subcommand: "DELUSER", ...usernames: (string | Buffer)[]],
): Promise<number>
Parameters
- ...args: [subcommand: "DELUSER", ...usernames: (string | Buffer)[]]
Returns Promise<number>
Inherited from Commander.acl
- Defined in utils/RedisCommander.ts:110
acl(
    subcommand: "DRYRUN",
    username: string | Buffer,
    command: string | Buffer,
    callback?: Callback<string>,
): Promise<string>
Simulates the execution of a command by a user, without executing the command.
- group: server
- complexity: O(1).
- since: 7.0.0
Parameters
- subcommand: "DRYRUN"
- username: string | Buffer
- command: string | Buffer
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.acl
- Defined in utils/RedisCommander.ts:120
acl(
    ...args: [
        subcommand: "DRYRUN",
        username: string
        | Buffer,
        command: string | Buffer,
        ...args: (string | number | Buffer)[],
        callback: Callback<string>,
    ],
): Promise<string>
Parameters
- ...args: [
      subcommand: "DRYRUN",
      username: string
      | Buffer,
      command: string | Buffer,
      ...args: (string | number | Buffer)[],
      callback: Callback<string>,
  ]
Returns Promise<string>
Inherited from Commander.acl
- Defined in utils/RedisCommander.ts:132
acl(
    ...args: [
        subcommand: "DRYRUN",
        username: string
        | Buffer,
        command: string | Buffer,
        ...args: (string | number | Buffer)[],
    ],
): Promise<string>
Parameters
- ...args: [
      subcommand: "DRYRUN",
      username: string
      | Buffer,
      command: string | Buffer,
      ...args: (string | number | Buffer)[],
  ]
Returns Promise<string>
Inherited from Commander.acl
- Defined in utils/RedisCommander.ts:150
acl(subcommand: "GENPASS", callback?: Callback<string>): Promise<string>
Generates a pseudorandom, secure password that can be used to identify ACL users.
- group: server
- complexity: O(1)
- since: 6.0.0
Parameters
- subcommand: "GENPASS"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.acl
- Defined in utils/RedisCommander.ts:173
acl(
    subcommand: "GENPASS",
    bits: string | number,
    callback?: Callback<string>,
): Promise<string>
Parameters
- subcommand: "GENPASS"
- bits: string | number
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.acl
- Defined in utils/RedisCommander.ts:181
acl(
    subcommand: "GETUSER",
    username: string | Buffer,
    callback?: Callback<string[]>,
): Promise<string[]>
Lists the ACL rules of a user.
- group: server
- complexity: O(N). Where N is the number of password, command and pattern rules that the user has.
- since: 6.0.0
Parameters
- subcommand: "GETUSER"
- username: string | Buffer
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.acl
- Defined in utils/RedisCommander.ts:198
acl(subcommand: "HELP", callback?: Callback<unknown>): Promise<unknown>
Returns helpful text about the different subcommands.
- group: server
- complexity: O(1)
- since: 6.0.0
Parameters
- subcommand: "HELP"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.acl
- Defined in utils/RedisCommander.ts:215
acl(subcommand: "LIST", callback?: Callback<string[]>): Promise<string[]>
Dumps the effective rules in ACL file format.
- group: server
- complexity: O(N). Where N is the number of configured users.
- since: 6.0.0
Parameters
- subcommand: "LIST"
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.acl
- Defined in utils/RedisCommander.ts:226
acl(subcommand: "LOAD", callback?: Callback<"OK">): Promise<"OK">
Reloads the rules from the configured ACL file.
- group: server
- complexity: O(N). Where N is the number of configured users.
- since: 6.0.0
Parameters
- subcommand: "LOAD"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.acl
- Defined in utils/RedisCommander.ts:241
acl(subcommand: "LOG", callback?: Callback<unknown>): Promise<unknown>
Lists recent security events generated due to ACL rules.
- group: server
- complexity: O(N) with N being the number of entries shown.
- since: 6.0.0
Parameters
- subcommand: "LOG"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.acl
- Defined in utils/RedisCommander.ts:249
acl(
    subcommand: "LOG",
    count: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "LOG"
- count: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.acl
- Defined in utils/RedisCommander.ts:253
acl(
    subcommand: "LOG",
    reset: "RESET",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "LOG"
- reset: "RESET"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.acl
- Defined in utils/RedisCommander.ts:258
acl(subcommand: "SAVE", callback?: Callback<"OK">): Promise<"OK">
Saves the effective ACL rules in the configured ACL file.
- group: server
- complexity: O(N). Where N is the number of configured users.
- since: 6.0.0
Parameters
- subcommand: "SAVE"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.acl
- Defined in utils/RedisCommander.ts:270
acl(
    subcommand: "SETUSER",
    username: string | Buffer,
    callback?: Callback<"OK">,
): Promise<"OK">
Creates and modifies an ACL user and its rules.
- group: server
- complexity: O(N). Where N is the number of rules provided.
- since: 6.0.0
Parameters
- subcommand: "SETUSER"
- username: string | Buffer
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.acl
- Defined in utils/RedisCommander.ts:278
acl(
    ...args: [
        subcommand: "SETUSER",
        username: string
        | Buffer,
        ...rules: (string | Buffer)[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      subcommand: "SETUSER",
      username: string
      | Buffer,
      ...rules: (string | Buffer)[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.acl
- Defined in utils/RedisCommander.ts:283
acl(
    ...args: [
        subcommand: "SETUSER",
        username: string
        | Buffer,
        ...rules: (string | Buffer)[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      subcommand: "SETUSER",
      username: string
      | Buffer,
      ...rules: (string | Buffer)[],
  ]
Returns Promise<"OK">
Inherited from Commander.acl
- Defined in utils/RedisCommander.ts:291
acl(subcommand: "USERS", callback?: Callback<string[]>): Promise<string[]>
Lists all ACL users.
- group: server
- complexity: O(N). Where N is the number of configured users.
- since: 6.0.0
Parameters
- subcommand: "USERS"
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.acl
- Defined in utils/RedisCommander.ts:305
acl(subcommand: "WHOAMI", callback?: Callback<string>): Promise<string>
Returns the authenticated username of the current connection.
- group: server
- complexity: O(1)
- since: 6.0.0
Parameters
- subcommand: "WHOAMI"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.acl
- Defined in utils/RedisCommander.ts:320

aclBuffer

aclBuffer(
    subcommand: "DRYRUN",
    username: string | Buffer,
    command: string | Buffer,
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- subcommand: "DRYRUN"
- username: string | Buffer
- command: string | Buffer
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.aclBuffer
- Defined in utils/RedisCommander.ts:126
aclBuffer(
    ...args: [
        subcommand: "DRYRUN",
        username: string
        | Buffer,
        command: string | Buffer,
        ...args: (string | number | Buffer)[],
        callback: Callback<Buffer>,
    ],
): Promise<Buffer>
Parameters
- ...args: [
      subcommand: "DRYRUN",
      username: string
      | Buffer,
      command: string | Buffer,
      ...args: (string | number | Buffer)[],
      callback: Callback<Buffer>,
  ]
Returns Promise<Buffer>
Inherited from Commander.aclBuffer
- Defined in utils/RedisCommander.ts:141
aclBuffer(
    ...args: [
        subcommand: "DRYRUN",
        username: string
        | Buffer,
        command: string | Buffer,
        ...args: (string | number | Buffer)[],
    ],
): Promise<Buffer>
Parameters
- ...args: [
      subcommand: "DRYRUN",
      username: string
      | Buffer,
      command: string | Buffer,
      ...args: (string | number | Buffer)[],
  ]
Returns Promise<Buffer>
Inherited from Commander.aclBuffer
- Defined in utils/RedisCommander.ts:158
aclBuffer(subcommand: "GENPASS", callback?: Callback<Buffer>): Promise<Buffer>
Parameters
- subcommand: "GENPASS"
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.aclBuffer
- Defined in utils/RedisCommander.ts:177
aclBuffer(
    subcommand: "GENPASS",
    bits: string | number,
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- subcommand: "GENPASS"
- bits: string | number
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.aclBuffer
- Defined in utils/RedisCommander.ts:186
aclBuffer(
    subcommand: "GETUSER",
    username: string | Buffer,
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- subcommand: "GETUSER"
- username: string | Buffer
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.aclBuffer
- Defined in utils/RedisCommander.ts:203
aclBuffer(subcommand: "LIST", callback?: Callback<Buffer[]>): Promise<Buffer[]>
Parameters
- subcommand: "LIST"
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.aclBuffer
- Defined in utils/RedisCommander.ts:230
aclBuffer(subcommand: "USERS", callback?: Callback<Buffer[]>): Promise<Buffer[]>
Parameters
- subcommand: "USERS"
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.aclBuffer
- Defined in utils/RedisCommander.ts:309
aclBuffer(subcommand: "WHOAMI", callback?: Callback<Buffer>): Promise<Buffer>
Parameters
- subcommand: "WHOAMI"
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.aclBuffer
- Defined in utils/RedisCommander.ts:324

addBuiltinCommand

addBuiltinCommand(commandName: string): void
Create add builtin command
Parameters
- commandName: string
Returns void
Inherited from Commander.addBuiltinCommand
- Defined in utils/Commander.ts:50

append

append(
    key: RedisKey,
    value: string | number | Buffer,
    callback?: Callback<number>,
): Promise<number>
Appends a string to the value of a key. Creates the key if it doesn't exist.
- group: string
- complexity: O(1). The amortized time complexity is O(1) assuming the appended value is small and the already present value is of any size, since the dynamic string library used by the server will double the free space available on every reallocation.
- since: 2.0.0
Parameters
- key: RedisKey
- value: string | number | Buffer
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.append
- Defined in utils/RedisCommander.ts:335

asking

asking(callback?: Callback<"OK">): Promise<"OK">
Signals that a cluster client is following an -ASK redirect.
- group: cluster
- complexity: O(1)
- since: 3.0.0
Parameters
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.asking
- Defined in utils/RedisCommander.ts:347

auth

auth(password: string | Buffer, callback?: Callback<"OK">): Promise<"OK">
Authenticates the connection.
- group: connection
- complexity: O(N) where N is the number of passwords defined for the user
- since: 1.0.0
Parameters
- password: string | Buffer
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.auth
- Defined in utils/RedisCommander.ts:355
auth(
    username: string | Buffer,
    password: string | Buffer,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- username: string | Buffer
- password: string | Buffer
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.auth
- Defined in utils/RedisCommander.ts:359

bgrewriteaof

bgrewriteaof(callback?: Callback<string>): Promise<string>
Asynchronously rewrites the append-only file to disk.
- group: server
- complexity: O(1)
- since: 1.0.0
Parameters
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.bgrewriteaof
- Defined in utils/RedisCommander.ts:371

bgrewriteaofBuffer

bgrewriteaofBuffer(callback?: Callback<Buffer>): Promise<Buffer>
Parameters
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.bgrewriteaofBuffer
- Defined in utils/RedisCommander.ts:372

bgsave

bgsave(callback?: Callback<"OK">): Promise<"OK">
Asynchronously saves the database(s) to disk.
- group: server
- complexity: O(1)
- since: 1.0.0
Parameters
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.bgsave
- Defined in utils/RedisCommander.ts:380
bgsave(schedule: "SCHEDULE", callback?: Callback<"OK">): Promise<"OK">
Parameters
- schedule: "SCHEDULE"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.bgsave
- Defined in utils/RedisCommander.ts:381

bitcount

bitcount(key: RedisKey, callback?: Callback<number>): Promise<number>
Counts the number of set bits (population counting) in a string.
- group: bitmap
- complexity: O(N)
- since: 2.6.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.bitcount
- Defined in utils/RedisCommander.ts:392
bitcount(
    key: RedisKey,
    start: string | number,
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- start: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.bitcount
- Defined in utils/RedisCommander.ts:393
bitcount(
    key: RedisKey,
    start: string | number,
    end: string | number,
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- start: string | number
- end: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.bitcount
- Defined in utils/RedisCommander.ts:398
bitcount(
    key: RedisKey,
    start: string | number,
    end: string | number,
    byte: "BYTE",
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- start: string | number
- end: string | number
- byte: "BYTE"
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.bitcount
- Defined in utils/RedisCommander.ts:404
bitcount(
    key: RedisKey,
    start: string | number,
    end: string | number,
    bit: "BIT",
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- start: string | number
- end: string | number
- bit: "BIT"
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.bitcount
- Defined in utils/RedisCommander.ts:411

bitfield

bitfield(key: RedisKey, callback?: Callback<unknown>): Promise<unknown>
Performs arbitrary bitfield integer operations on strings.
- group: bitmap
- complexity: O(1) for each subcommand specified
- since: 3.2.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.bitfield
- Defined in utils/RedisCommander.ts:425
bitfield(
    key: RedisKey,
    getBlockToken: "GET",
    encoding: string | Buffer,
    offset: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- getBlockToken: "GET"
- encoding: string | Buffer
- offset: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.bitfield
- Defined in utils/RedisCommander.ts:429
bitfield(
    key: RedisKey,
    setBlockToken: "SET",
    encoding: string | Buffer,
    offset: string | number,
    value: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- setBlockToken: "SET"
- encoding: string | Buffer
- offset: string | number
- value: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.bitfield
- Defined in utils/RedisCommander.ts:436
bitfield(
    key: RedisKey,
    incrbyBlockToken: "INCRBY",
    encoding: string | Buffer,
    offset: string | number,
    increment: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- incrbyBlockToken: "INCRBY"
- encoding: string | Buffer
- offset: string | number
- increment: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.bitfield
- Defined in utils/RedisCommander.ts:444
bitfield(
    key: RedisKey,
    overflow: "OVERFLOW",
    wrap: "WRAP",
    setBlockToken: "SET",
    encoding: string | Buffer,
    offset: string | number,
    value: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- overflow: "OVERFLOW"
- wrap: "WRAP"
- setBlockToken: "SET"
- encoding: string | Buffer
- offset: string | number
- value: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.bitfield
- Defined in utils/RedisCommander.ts:452
bitfield(
    key: RedisKey,
    overflow: "OVERFLOW",
    wrap: "WRAP",
    incrbyBlockToken: "INCRBY",
    encoding: string | Buffer,
    offset: string | number,
    increment: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- overflow: "OVERFLOW"
- wrap: "WRAP"
- incrbyBlockToken: "INCRBY"
- encoding: string | Buffer
- offset: string | number
- increment: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.bitfield
- Defined in utils/RedisCommander.ts:462
bitfield(
    key: RedisKey,
    overflow: "OVERFLOW",
    sat: "SAT",
    setBlockToken: "SET",
    encoding: string | Buffer,
    offset: string | number,
    value: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- overflow: "OVERFLOW"
- sat: "SAT"
- setBlockToken: "SET"
- encoding: string | Buffer
- offset: string | number
- value: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.bitfield
- Defined in utils/RedisCommander.ts:472
bitfield(
    key: RedisKey,
    overflow: "OVERFLOW",
    sat: "SAT",
    incrbyBlockToken: "INCRBY",
    encoding: string | Buffer,
    offset: string | number,
    increment: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- overflow: "OVERFLOW"
- sat: "SAT"
- incrbyBlockToken: "INCRBY"
- encoding: string | Buffer
- offset: string | number
- increment: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.bitfield
- Defined in utils/RedisCommander.ts:482
bitfield(
    key: RedisKey,
    overflow: "OVERFLOW",
    fail: "FAIL",
    setBlockToken: "SET",
    encoding: string | Buffer,
    offset: string | number,
    value: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- overflow: "OVERFLOW"
- fail: "FAIL"
- setBlockToken: "SET"
- encoding: string | Buffer
- offset: string | number
- value: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.bitfield
- Defined in utils/RedisCommander.ts:492
bitfield(
    key: RedisKey,
    overflow: "OVERFLOW",
    fail: "FAIL",
    incrbyBlockToken: "INCRBY",
    encoding: string | Buffer,
    offset: string | number,
    increment: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- overflow: "OVERFLOW"
- fail: "FAIL"
- incrbyBlockToken: "INCRBY"
- encoding: string | Buffer
- offset: string | number
- increment: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.bitfield
- Defined in utils/RedisCommander.ts:502

bitfield_ro

bitfield_ro(key: RedisKey, callback?: Callback<unknown[]>): Promise<unknown[]>
Performs arbitrary read-only bitfield integer operations on strings.
- group: bitmap
- complexity: O(1) for each subcommand specified
- since: 6.0.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.bitfield_ro
- Defined in utils/RedisCommander.ts:519
bitfield_ro(
    ...args: [
        key: RedisKey,
        getBlockToken: "GET",
        ...getBlocks: (string | number | Buffer)[],
        callback: Callback<unknown[]>,
    ],
): Promise<unknown[]>
Parameters
- ...args: [
      key: RedisKey,
      getBlockToken: "GET",
      ...getBlocks: (string | number | Buffer)[],
      callback: Callback<unknown[]>,
  ]
Returns Promise<unknown[]>
Inherited from Commander.bitfield_ro
- Defined in utils/RedisCommander.ts:523
bitfield_ro(
    ...args: [
        key: RedisKey,
        getBlockToken: "GET",
        ...getBlocks: (string | number | Buffer)[],
    ],
): Promise<unknown[]>
Parameters
- ...args: [
      key: RedisKey,
      getBlockToken: "GET",
      ...getBlocks: (string | number | Buffer)[],
  ]
Returns Promise<unknown[]>
Inherited from Commander.bitfield_ro
- Defined in utils/RedisCommander.ts:531

bitop

bitop(
    ...args: [
        and: "AND",
        destkey: RedisKey,
        ...keys: RedisKey[],
        callback: Callback<number>,
    ],
): Promise<number>
Performs bitwise operations on multiple strings, and stores the result.
- group: bitmap
- complexity: O(N)
- since: 2.6.0
Parameters
- ...args: [and: "AND", destkey: RedisKey, ...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Inherited from Commander.bitop
- Defined in utils/RedisCommander.ts:545
bitop(
    ...args: [
        and: "AND",
        destkey: RedisKey,
        keys: RedisKey[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [and: "AND", destkey: RedisKey, keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Inherited from Commander.bitop
- Defined in utils/RedisCommander.ts:553
bitop(
...args: [and: "AND", destkey: RedisKey, ...keys: RedisKey[]],
): Promise<number>
Parameters
- ...args: [and: "AND", destkey: RedisKey, ...keys: RedisKey[]]
Returns Promise<number>
Inherited from Commander.bitop
- Defined in utils/RedisCommander.ts:561
bitop(
...args: [and: "AND", destkey: RedisKey, keys: RedisKey[]],
): Promise<number>
Parameters
- ...args: [and: "AND", destkey: RedisKey, keys: RedisKey[]]
Returns Promise<number>
Inherited from Commander.bitop
- Defined in utils/RedisCommander.ts:564
bitop(
    ...args: [
        or: "OR",
        destkey: RedisKey,
        ...keys: RedisKey[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [or: "OR", destkey: RedisKey, ...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Inherited from Commander.bitop
- Defined in utils/RedisCommander.ts:567
bitop(
    ...args: [
        or: "OR",
        destkey: RedisKey,
        keys: RedisKey[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [or: "OR", destkey: RedisKey, keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Inherited from Commander.bitop
- Defined in utils/RedisCommander.ts:575
bitop(
...args: [or: "OR", destkey: RedisKey, ...keys: RedisKey[]],
): Promise<number>
Parameters
- ...args: [or: "OR", destkey: RedisKey, ...keys: RedisKey[]]
Returns Promise<number>
Inherited from Commander.bitop
- Defined in utils/RedisCommander.ts:583
bitop(...args: [or: "OR", destkey: RedisKey, keys: RedisKey[]]): Promise<number>
Parameters
- ...args: [or: "OR", destkey: RedisKey, keys: RedisKey[]]
Returns Promise<number>
Inherited from Commander.bitop
- Defined in utils/RedisCommander.ts:586
bitop(
    ...args: [
        xor: "XOR",
        destkey: RedisKey,
        ...keys: RedisKey[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [xor: "XOR", destkey: RedisKey, ...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Inherited from Commander.bitop
- Defined in utils/RedisCommander.ts:589
bitop(
    ...args: [
        xor: "XOR",
        destkey: RedisKey,
        keys: RedisKey[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [xor: "XOR", destkey: RedisKey, keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Inherited from Commander.bitop
- Defined in utils/RedisCommander.ts:597
bitop(
...args: [xor: "XOR", destkey: RedisKey, ...keys: RedisKey[]],
): Promise<number>
Parameters
- ...args: [xor: "XOR", destkey: RedisKey, ...keys: RedisKey[]]
Returns Promise<number>
Inherited from Commander.bitop
- Defined in utils/RedisCommander.ts:605
bitop(
...args: [xor: "XOR", destkey: RedisKey, keys: RedisKey[]],
): Promise<number>
Parameters
- ...args: [xor: "XOR", destkey: RedisKey, keys: RedisKey[]]
Returns Promise<number>
Inherited from Commander.bitop
- Defined in utils/RedisCommander.ts:608
bitop(
    ...args: [
        not: "NOT",
        destkey: RedisKey,
        ...keys: RedisKey[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [not: "NOT", destkey: RedisKey, ...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Inherited from Commander.bitop
- Defined in utils/RedisCommander.ts:611
bitop(
    ...args: [
        not: "NOT",
        destkey: RedisKey,
        keys: RedisKey[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [not: "NOT", destkey: RedisKey, keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Inherited from Commander.bitop
- Defined in utils/RedisCommander.ts:619
bitop(
...args: [not: "NOT", destkey: RedisKey, ...keys: RedisKey[]],
): Promise<number>
Parameters
- ...args: [not: "NOT", destkey: RedisKey, ...keys: RedisKey[]]
Returns Promise<number>
Inherited from Commander.bitop
- Defined in utils/RedisCommander.ts:627
bitop(
...args: [not: "NOT", destkey: RedisKey, keys: RedisKey[]],
): Promise<number>
Parameters
- ...args: [not: "NOT", destkey: RedisKey, keys: RedisKey[]]
Returns Promise<number>
Inherited from Commander.bitop
- Defined in utils/RedisCommander.ts:630

bitpos

bitpos(
    key: RedisKey,
    bit: string | number,
    callback?: Callback<number>,
): Promise<number>
Finds the first set (1) or clear (0) bit in a string.
- group: bitmap
- complexity: O(N)
- since: 2.8.7
Parameters
- key: RedisKey
- bit: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.bitpos
- Defined in utils/RedisCommander.ts:640
bitpos(
    key: RedisKey,
    bit: string | number,
    start: string | number,
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- bit: string | number
- start: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.bitpos
- Defined in utils/RedisCommander.ts:645
bitpos(
    key: RedisKey,
    bit: string | number,
    start: string | number,
    end: string | number,
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- bit: string | number
- start: string | number
- end: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.bitpos
- Defined in utils/RedisCommander.ts:651
bitpos(
    key: RedisKey,
    bit: string | number,
    start: string | number,
    end: string | number,
    byte: "BYTE",
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- bit: string | number
- start: string | number
- end: string | number
- byte: "BYTE"
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.bitpos
- Defined in utils/RedisCommander.ts:658
bitpos(
    key: RedisKey,
    bit: string | number,
    start: string | number,
    end: string | number,
    bit1: "BIT",
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- bit: string | number
- start: string | number
- end: string | number
- bit1: "BIT"
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.bitpos
- Defined in utils/RedisCommander.ts:666

blmove

blmove(
    source: RedisKey,
    destination: RedisKey,
    left: "LEFT",
    left1: "LEFT",
    timeout: string | number,
    callback?: Callback<string>,
): Promise<string>
Pops an element from a list, pushes it to another list and returns it. Blocks until an element is available otherwise. Deletes the list if the last element was moved.
- group: list
- complexity: O(1)
- since: 6.2.0
Parameters
- source: RedisKey
- destination: RedisKey
- left: "LEFT"
- left1: "LEFT"
- timeout: string | number
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.blmove
- Defined in utils/RedisCommander.ts:681
blmove(
    source: RedisKey,
    destination: RedisKey,
    left: "LEFT",
    right: "RIGHT",
    timeout: string | number,
    callback?: Callback<string>,
): Promise<string>
Parameters
- source: RedisKey
- destination: RedisKey
- left: "LEFT"
- right: "RIGHT"
- timeout: string | number
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.blmove
- Defined in utils/RedisCommander.ts:697
blmove(
    source: RedisKey,
    destination: RedisKey,
    right: "RIGHT",
    left: "LEFT",
    timeout: string | number,
    callback?: Callback<string>,
): Promise<string>
Parameters
- source: RedisKey
- destination: RedisKey
- right: "RIGHT"
- left: "LEFT"
- timeout: string | number
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.blmove
- Defined in utils/RedisCommander.ts:713
blmove(
    source: RedisKey,
    destination: RedisKey,
    right: "RIGHT",
    right1: "RIGHT",
    timeout: string | number,
    callback?: Callback<string>,
): Promise<string>
Parameters
- source: RedisKey
- destination: RedisKey
- right: "RIGHT"
- right1: "RIGHT"
- timeout: string | number
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.blmove
- Defined in utils/RedisCommander.ts:729

blmoveBuffer

blmoveBuffer(
    source: RedisKey,
    destination: RedisKey,
    left: "LEFT",
    left1: "LEFT",
    timeout: string | number,
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- source: RedisKey
- destination: RedisKey
- left: "LEFT"
- left1: "LEFT"
- timeout: string | number
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.blmoveBuffer
- Defined in utils/RedisCommander.ts:689
blmoveBuffer(
    source: RedisKey,
    destination: RedisKey,
    left: "LEFT",
    right: "RIGHT",
    timeout: string | number,
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- source: RedisKey
- destination: RedisKey
- left: "LEFT"
- right: "RIGHT"
- timeout: string | number
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.blmoveBuffer
- Defined in utils/RedisCommander.ts:705
blmoveBuffer(
    source: RedisKey,
    destination: RedisKey,
    right: "RIGHT",
    left: "LEFT",
    timeout: string | number,
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- source: RedisKey
- destination: RedisKey
- right: "RIGHT"
- left: "LEFT"
- timeout: string | number
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.blmoveBuffer
- Defined in utils/RedisCommander.ts:721
blmoveBuffer(
    source: RedisKey,
    destination: RedisKey,
    right: "RIGHT",
    right1: "RIGHT",
    timeout: string | number,
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- source: RedisKey
- destination: RedisKey
- right: "RIGHT"
- right1: "RIGHT"
- timeout: string | number
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.blmoveBuffer
- Defined in utils/RedisCommander.ts:737

blmpop

blmpop(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        ...keys: RedisKey[],
        left: "LEFT",
        callback: Callback<[key: string, members: string[]]>,
    ],
): Promise<[key: string, members: string[]]>
Pops the first element from one of multiple lists. Blocks until an element is available otherwise. Deletes the list if the last element was popped.
- group: list
- complexity: O(N+M) where N is the number of provided keys and M is the number of elements returned.
- since: 7.0.0
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      ...keys: RedisKey[],
      left: "LEFT",
      callback: Callback<[key: string, members: string[]]>,
  ]
Returns Promise<[key: string, members: string[]]>
Inherited from Commander.blmpop
- Defined in utils/RedisCommander.ts:752
blmpop(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        keys: RedisKey[],
        left: "LEFT",
        callback: Callback<[key: string, members: string[]]>,
    ],
): Promise<[key: string, members: string[]]>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      keys: RedisKey[],
      left: "LEFT",
      callback: Callback<[key: string, members: string[]]>,
  ]
Returns Promise<[key: string, members: string[]]>
Inherited from Commander.blmpop
- Defined in utils/RedisCommander.ts:770
blmpop(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        ...keys: RedisKey[],
        left: "LEFT",
    ],
): Promise<[key: string, members: string[]]>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      ...keys: RedisKey[],
      left: "LEFT",
  ]
Returns Promise<[key: string, members: string[]]>
Inherited from Commander.blmpop
- Defined in utils/RedisCommander.ts:788
blmpop(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        keys: RedisKey[],
        left: "LEFT",
    ],
): Promise<[key: string, members: string[]]>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      keys: RedisKey[],
      left: "LEFT",
  ]
Returns Promise<[key: string, members: string[]]>
Inherited from Commander.blmpop
- Defined in utils/RedisCommander.ts:804
blmpop(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        ...keys: RedisKey[],
        left: "LEFT",
        countToken: "COUNT",
        count: string | number,
        callback: Callback<[key: string, members: string[]]>,
    ],
): Promise<[key: string, members: string[]]>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      ...keys: RedisKey[],
      left: "LEFT",
      countToken: "COUNT",
      count: string | number,
      callback: Callback<[key: string, members: string[]]>,
  ]
Returns Promise<[key: string, members: string[]]>
Inherited from Commander.blmpop
- Defined in utils/RedisCommander.ts:820
blmpop(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        keys: RedisKey[],
        left: "LEFT",
        countToken: "COUNT",
        count: string | number,
        callback: Callback<[key: string, members: string[]]>,
    ],
): Promise<[key: string, members: string[]]>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      keys: RedisKey[],
      left: "LEFT",
      countToken: "COUNT",
      count: string | number,
      callback: Callback<[key: string, members: string[]]>,
  ]
Returns Promise<[key: string, members: string[]]>
Inherited from Commander.blmpop
- Defined in utils/RedisCommander.ts:842
blmpop(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        ...keys: RedisKey[],
        left: "LEFT",
        countToken: "COUNT",
        count: string | number,
    ],
): Promise<[key: string, members: string[]]>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      ...keys: RedisKey[],
      left: "LEFT",
      countToken: "COUNT",
      count: string | number,
  ]
Returns Promise<[key: string, members: string[]]>
Inherited from Commander.blmpop
- Defined in utils/RedisCommander.ts:864
blmpop(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        keys: RedisKey[],
        left: "LEFT",
        countToken: "COUNT",
        count: string | number,
    ],
): Promise<[key: string, members: string[]]>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      keys: RedisKey[],
      left: "LEFT",
      countToken: "COUNT",
      count: string | number,
  ]
Returns Promise<[key: string, members: string[]]>
Inherited from Commander.blmpop
- Defined in utils/RedisCommander.ts:884
blmpop(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        ...keys: RedisKey[],
        right: "RIGHT",
        callback: Callback<[key: string, members: string[]]>,
    ],
): Promise<[key: string, members: string[]]>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      ...keys: RedisKey[],
      right: "RIGHT",
      callback: Callback<[key: string, members: string[]]>,
  ]
Returns Promise<[key: string, members: string[]]>
Inherited from Commander.blmpop
- Defined in utils/RedisCommander.ts:904
blmpop(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        keys: RedisKey[],
        right: "RIGHT",
        callback: Callback<[key: string, members: string[]]>,
    ],
): Promise<[key: string, members: string[]]>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      keys: RedisKey[],
      right: "RIGHT",
      callback: Callback<[key: string, members: string[]]>,
  ]
Returns Promise<[key: string, members: string[]]>
Inherited from Commander.blmpop
- Defined in utils/RedisCommander.ts:922
blmpop(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        ...keys: RedisKey[],
        right: "RIGHT",
    ],
): Promise<[key: string, members: string[]]>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      ...keys: RedisKey[],
      right: "RIGHT",
  ]
Returns Promise<[key: string, members: string[]]>
Inherited from Commander.blmpop
- Defined in utils/RedisCommander.ts:940
blmpop(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        keys: RedisKey[],
        right: "RIGHT",
    ],
): Promise<[key: string, members: string[]]>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      keys: RedisKey[],
      right: "RIGHT",
  ]
Returns Promise<[key: string, members: string[]]>
Inherited from Commander.blmpop
- Defined in utils/RedisCommander.ts:956
blmpop(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        ...keys: RedisKey[],
        right: "RIGHT",
        countToken: "COUNT",
        count: string | number,
        callback: Callback<[key: string, members: string[]]>,
    ],
): Promise<[key: string, members: string[]]>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      ...keys: RedisKey[],
      right: "RIGHT",
      countToken: "COUNT",
      count: string | number,
      callback: Callback<[key: string, members: string[]]>,
  ]
Returns Promise<[key: string, members: string[]]>
Inherited from Commander.blmpop
- Defined in utils/RedisCommander.ts:972
blmpop(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        keys: RedisKey[],
        right: "RIGHT",
        countToken: "COUNT",
        count: string | number,
        callback: Callback<[key: string, members: string[]]>,
    ],
): Promise<[key: string, members: string[]]>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      keys: RedisKey[],
      right: "RIGHT",
      countToken: "COUNT",
      count: string | number,
      callback: Callback<[key: string, members: string[]]>,
  ]
Returns Promise<[key: string, members: string[]]>
Inherited from Commander.blmpop
- Defined in utils/RedisCommander.ts:994
blmpop(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        ...keys: RedisKey[],
        right: "RIGHT",
        countToken: "COUNT",
        count: string | number,
    ],
): Promise<[key: string, members: string[]]>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      ...keys: RedisKey[],
      right: "RIGHT",
      countToken: "COUNT",
      count: string | number,
  ]
Returns Promise<[key: string, members: string[]]>
Inherited from Commander.blmpop
- Defined in utils/RedisCommander.ts:1016
blmpop(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        keys: RedisKey[],
        right: "RIGHT",
        countToken: "COUNT",
        count: string | number,
    ],
): Promise<[key: string, members: string[]]>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      keys: RedisKey[],
      right: "RIGHT",
      countToken: "COUNT",
      count: string | number,
  ]
Returns Promise<[key: string, members: string[]]>
Inherited from Commander.blmpop
- Defined in utils/RedisCommander.ts:1036

blmpopBuffer

blmpopBuffer(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        ...keys: RedisKey[],
        left: "LEFT",
        callback: Callback<[key: Buffer, members: Buffer[]]>,
    ],
): Promise<[key: Buffer, members: Buffer[]]>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      ...keys: RedisKey[],
      left: "LEFT",
      callback: Callback<[key: Buffer, members: Buffer[]]>,
  ]
Returns Promise<[key: Buffer, members: Buffer[]]>
Inherited from Commander.blmpopBuffer
- Defined in utils/RedisCommander.ts:761
blmpopBuffer(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        keys: RedisKey[],
        left: "LEFT",
        callback: Callback<[key: Buffer, members: Buffer[]]>,
    ],
): Promise<[key: Buffer, members: Buffer[]]>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      keys: RedisKey[],
      left: "LEFT",
      callback: Callback<[key: Buffer, members: Buffer[]]>,
  ]
Returns Promise<[key: Buffer, members: Buffer[]]>
Inherited from Commander.blmpopBuffer
- Defined in utils/RedisCommander.ts:779
blmpopBuffer(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        ...keys: RedisKey[],
        left: "LEFT",
    ],
): Promise<[key: Buffer, members: Buffer[]]>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      ...keys: RedisKey[],
      left: "LEFT",
  ]
Returns Promise<[key: Buffer, members: Buffer[]]>
Inherited from Commander.blmpopBuffer
- Defined in utils/RedisCommander.ts:796
blmpopBuffer(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        keys: RedisKey[],
        left: "LEFT",
    ],
): Promise<[key: Buffer, members: Buffer[]]>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      keys: RedisKey[],
      left: "LEFT",
  ]
Returns Promise<[key: Buffer, members: Buffer[]]>
Inherited from Commander.blmpopBuffer
- Defined in utils/RedisCommander.ts:812
blmpopBuffer(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        ...keys: RedisKey[],
        left: "LEFT",
        countToken: "COUNT",
        count: string | number,
        callback: Callback<[key: Buffer, members: Buffer[]]>,
    ],
): Promise<[key: Buffer, members: Buffer[]]>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      ...keys: RedisKey[],
      left: "LEFT",
      countToken: "COUNT",
      count: string | number,
      callback: Callback<[key: Buffer, members: Buffer[]]>,
  ]
Returns Promise<[key: Buffer, members: Buffer[]]>
Inherited from Commander.blmpopBuffer
- Defined in utils/RedisCommander.ts:831
blmpopBuffer(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        keys: RedisKey[],
        left: "LEFT",
        countToken: "COUNT",
        count: string | number,
        callback: Callback<[key: Buffer, members: Buffer[]]>,
    ],
): Promise<[key: Buffer, members: Buffer[]]>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      keys: RedisKey[],
      left: "LEFT",
      countToken: "COUNT",
      count: string | number,
      callback: Callback<[key: Buffer, members: Buffer[]]>,
  ]
Returns Promise<[key: Buffer, members: Buffer[]]>
Inherited from Commander.blmpopBuffer
- Defined in utils/RedisCommander.ts:853
blmpopBuffer(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        ...keys: RedisKey[],
        left: "LEFT",
        countToken: "COUNT",
        count: string | number,
    ],
): Promise<[key: Buffer, members: Buffer[]]>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      ...keys: RedisKey[],
      left: "LEFT",
      countToken: "COUNT",
      count: string | number,
  ]
Returns Promise<[key: Buffer, members: Buffer[]]>
Inherited from Commander.blmpopBuffer
- Defined in utils/RedisCommander.ts:874
blmpopBuffer(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        keys: RedisKey[],
        left: "LEFT",
        countToken: "COUNT",
        count: string | number,
    ],
): Promise<[key: Buffer, members: Buffer[]]>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      keys: RedisKey[],
      left: "LEFT",
      countToken: "COUNT",
      count: string | number,
  ]
Returns Promise<[key: Buffer, members: Buffer[]]>
Inherited from Commander.blmpopBuffer
- Defined in utils/RedisCommander.ts:894
blmpopBuffer(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        ...keys: RedisKey[],
        right: "RIGHT",
        callback: Callback<[key: Buffer, members: Buffer[]]>,
    ],
): Promise<[key: Buffer, members: Buffer[]]>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      ...keys: RedisKey[],
      right: "RIGHT",
      callback: Callback<[key: Buffer, members: Buffer[]]>,
  ]
Returns Promise<[key: Buffer, members: Buffer[]]>
Inherited from Commander.blmpopBuffer
- Defined in utils/RedisCommander.ts:913
blmpopBuffer(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        keys: RedisKey[],
        right: "RIGHT",
        callback: Callback<[key: Buffer, members: Buffer[]]>,
    ],
): Promise<[key: Buffer, members: Buffer[]]>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      keys: RedisKey[],
      right: "RIGHT",
      callback: Callback<[key: Buffer, members: Buffer[]]>,
  ]
Returns Promise<[key: Buffer, members: Buffer[]]>
Inherited from Commander.blmpopBuffer
- Defined in utils/RedisCommander.ts:931
blmpopBuffer(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        ...keys: RedisKey[],
        right: "RIGHT",
    ],
): Promise<[key: Buffer, members: Buffer[]]>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      ...keys: RedisKey[],
      right: "RIGHT",
  ]
Returns Promise<[key: Buffer, members: Buffer[]]>
Inherited from Commander.blmpopBuffer
- Defined in utils/RedisCommander.ts:948
blmpopBuffer(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        keys: RedisKey[],
        right: "RIGHT",
    ],
): Promise<[key: Buffer, members: Buffer[]]>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      keys: RedisKey[],
      right: "RIGHT",
  ]
Returns Promise<[key: Buffer, members: Buffer[]]>
Inherited from Commander.blmpopBuffer
- Defined in utils/RedisCommander.ts:964
blmpopBuffer(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        ...keys: RedisKey[],
        right: "RIGHT",
        countToken: "COUNT",
        count: string | number,
        callback: Callback<[key: Buffer, members: Buffer[]]>,
    ],
): Promise<[key: Buffer, members: Buffer[]]>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      ...keys: RedisKey[],
      right: "RIGHT",
      countToken: "COUNT",
      count: string | number,
      callback: Callback<[key: Buffer, members: Buffer[]]>,
  ]
Returns Promise<[key: Buffer, members: Buffer[]]>
Inherited from Commander.blmpopBuffer
- Defined in utils/RedisCommander.ts:983
blmpopBuffer(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        keys: RedisKey[],
        right: "RIGHT",
        countToken: "COUNT",
        count: string | number,
        callback: Callback<[key: Buffer, members: Buffer[]]>,
    ],
): Promise<[key: Buffer, members: Buffer[]]>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      keys: RedisKey[],
      right: "RIGHT",
      countToken: "COUNT",
      count: string | number,
      callback: Callback<[key: Buffer, members: Buffer[]]>,
  ]
Returns Promise<[key: Buffer, members: Buffer[]]>
Inherited from Commander.blmpopBuffer
- Defined in utils/RedisCommander.ts:1005
blmpopBuffer(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        ...keys: RedisKey[],
        right: "RIGHT",
        countToken: "COUNT",
        count: string | number,
    ],
): Promise<[key: Buffer, members: Buffer[]]>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      ...keys: RedisKey[],
      right: "RIGHT",
      countToken: "COUNT",
      count: string | number,
  ]
Returns Promise<[key: Buffer, members: Buffer[]]>
Inherited from Commander.blmpopBuffer
- Defined in utils/RedisCommander.ts:1026
blmpopBuffer(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        keys: RedisKey[],
        right: "RIGHT",
        countToken: "COUNT",
        count: string | number,
    ],
): Promise<[key: Buffer, members: Buffer[]]>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      keys: RedisKey[],
      right: "RIGHT",
      countToken: "COUNT",
      count: string | number,
  ]
Returns Promise<[key: Buffer, members: Buffer[]]>
Inherited from Commander.blmpopBuffer
- Defined in utils/RedisCommander.ts:1046

blpop

blpop(
    ...args: [
        ...keys: RedisKey[],
        timeout: string
        | number,
        callback: Callback<[string, string]>,
    ],
): Promise<[string, string]>
Removes and returns the first element in a list. Blocks until an element is available otherwise. Deletes the list if the last element was popped.
- group: list
- complexity: O(N) where N is the number of provided keys.
- since: 2.0.0
Parameters
- ...args: [
      ...keys: RedisKey[],
      timeout: string
      | number,
      callback: Callback<[string, string]>,
  ]
Returns Promise<[string, string]>
Inherited from Commander.blpop
- Defined in utils/RedisCommander.ts:1063
blpop(
    ...args: [
        keys: RedisKey[],
        timeout: string
        | number,
        callback: Callback<[string, string]>,
    ],
): Promise<[string, string]>
Parameters
- ...args: [
      keys: RedisKey[],
      timeout: string
      | number,
      callback: Callback<[string, string]>,
  ]
Returns Promise<[string, string]>
Inherited from Commander.blpop
- Defined in utils/RedisCommander.ts:1077
blpop(
...args: [...keys: RedisKey[], timeout: string | number],
): Promise<[string, string]>
Parameters
- ...args: [...keys: RedisKey[], timeout: string | number]
Returns Promise<[string, string]>
Inherited from Commander.blpop
- Defined in utils/RedisCommander.ts:1091
blpop(
...args: [keys: RedisKey[], timeout: string | number],
): Promise<[string, string]>
Parameters
- ...args: [keys: RedisKey[], timeout: string | number]
Returns Promise<[string, string]>
Inherited from Commander.blpop
- Defined in utils/RedisCommander.ts:1097

blpopBuffer

blpopBuffer(
    ...args: [
        ...keys: RedisKey[],
        timeout: string
        | number,
        callback: Callback<[Buffer, Buffer]>,
    ],
): Promise<[Buffer, Buffer]>
Parameters
- ...args: [
      ...keys: RedisKey[],
      timeout: string
      | number,
      callback: Callback<[Buffer, Buffer]>,
  ]
Returns Promise<[Buffer, Buffer]>
Inherited from Commander.blpopBuffer
- Defined in utils/RedisCommander.ts:1070
blpopBuffer(
    ...args: [
        keys: RedisKey[],
        timeout: string
        | number,
        callback: Callback<[Buffer, Buffer]>,
    ],
): Promise<[Buffer, Buffer]>
Parameters
- ...args: [
      keys: RedisKey[],
      timeout: string
      | number,
      callback: Callback<[Buffer, Buffer]>,
  ]
Returns Promise<[Buffer, Buffer]>
Inherited from Commander.blpopBuffer
- Defined in utils/RedisCommander.ts:1084
blpopBuffer(
...args: [...keys: RedisKey[], timeout: string | number],
): Promise<[Buffer, Buffer]>
Parameters
- ...args: [...keys: RedisKey[], timeout: string | number]
Returns Promise<[Buffer, Buffer]>
Inherited from Commander.blpopBuffer
- Defined in utils/RedisCommander.ts:1094
blpopBuffer(
...args: [keys: RedisKey[], timeout: string | number],
): Promise<[Buffer, Buffer]>
Parameters
- ...args: [keys: RedisKey[], timeout: string | number]
Returns Promise<[Buffer, Buffer]>
Inherited from Commander.blpopBuffer
- Defined in utils/RedisCommander.ts:1100

brpop

brpop(
    ...args: [
        ...keys: RedisKey[],
        timeout: string
        | number,
        callback: Callback<[string, string]>,
    ],
): Promise<[string, string]>
Removes and returns the last element in a list. Blocks until an element is available otherwise. Deletes the list if the last element was popped.
- group: list
- complexity: O(N) where N is the number of provided keys.
- since: 2.0.0
Parameters
- ...args: [
      ...keys: RedisKey[],
      timeout: string
      | number,
      callback: Callback<[string, string]>,
  ]
Returns Promise<[string, string]>
Inherited from Commander.brpop
- Defined in utils/RedisCommander.ts:1110
brpop(
    ...args: [
        keys: RedisKey[],
        timeout: string
        | number,
        callback: Callback<[string, string]>,
    ],
): Promise<[string, string]>
Parameters
- ...args: [
      keys: RedisKey[],
      timeout: string
      | number,
      callback: Callback<[string, string]>,
  ]
Returns Promise<[string, string]>
Inherited from Commander.brpop
- Defined in utils/RedisCommander.ts:1124
brpop(
...args: [...keys: RedisKey[], timeout: string | number],
): Promise<[string, string]>
Parameters
- ...args: [...keys: RedisKey[], timeout: string | number]
Returns Promise<[string, string]>
Inherited from Commander.brpop
- Defined in utils/RedisCommander.ts:1138
brpop(
...args: [keys: RedisKey[], timeout: string | number],
): Promise<[string, string]>
Parameters
- ...args: [keys: RedisKey[], timeout: string | number]
Returns Promise<[string, string]>
Inherited from Commander.brpop
- Defined in utils/RedisCommander.ts:1144

brpopBuffer

brpopBuffer(
    ...args: [
        ...keys: RedisKey[],
        timeout: string
        | number,
        callback: Callback<[Buffer, Buffer]>,
    ],
): Promise<[Buffer, Buffer]>
Parameters
- ...args: [
      ...keys: RedisKey[],
      timeout: string
      | number,
      callback: Callback<[Buffer, Buffer]>,
  ]
Returns Promise<[Buffer, Buffer]>
Inherited from Commander.brpopBuffer
- Defined in utils/RedisCommander.ts:1117
brpopBuffer(
    ...args: [
        keys: RedisKey[],
        timeout: string
        | number,
        callback: Callback<[Buffer, Buffer]>,
    ],
): Promise<[Buffer, Buffer]>
Parameters
- ...args: [
      keys: RedisKey[],
      timeout: string
      | number,
      callback: Callback<[Buffer, Buffer]>,
  ]
Returns Promise<[Buffer, Buffer]>
Inherited from Commander.brpopBuffer
- Defined in utils/RedisCommander.ts:1131
brpopBuffer(
...args: [...keys: RedisKey[], timeout: string | number],
): Promise<[Buffer, Buffer]>
Parameters
- ...args: [...keys: RedisKey[], timeout: string | number]
Returns Promise<[Buffer, Buffer]>
Inherited from Commander.brpopBuffer
- Defined in utils/RedisCommander.ts:1141
brpopBuffer(
...args: [keys: RedisKey[], timeout: string | number],
): Promise<[Buffer, Buffer]>
Parameters
- ...args: [keys: RedisKey[], timeout: string | number]
Returns Promise<[Buffer, Buffer]>
Inherited from Commander.brpopBuffer
- Defined in utils/RedisCommander.ts:1147

brpoplpush

brpoplpush(
    source: RedisKey,
    destination: RedisKey,
    timeout: string | number,
    callback?: Callback<string>,
): Promise<string>
Pops an element from a list, pushes it to another list and returns it. Block until an element is available otherwise. Deletes the list if the last element was popped.
- group: list
- complexity: O(1)
- since: 2.2.0
Parameters
- source: RedisKey
- destination: RedisKey
- timeout: string | number
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.brpoplpush
- Defined in utils/RedisCommander.ts:1157

brpoplpushBuffer

brpoplpushBuffer(
    source: RedisKey,
    destination: RedisKey,
    timeout: string | number,
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- source: RedisKey
- destination: RedisKey
- timeout: string | number
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.brpoplpushBuffer
- Defined in utils/RedisCommander.ts:1163

bzmpop

bzmpop(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        ...keys: RedisKey[],
        min: "MIN",
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Removes and returns a member by score from one or more sorted sets. Blocks until a member is available otherwise. Deletes the sorted set if the last element was popped.
- group: sorted-set
- complexity: O(K) + O(M*log(N)) where K is the number of provided keys, N being the number of elements in the sorted set, and M being the number of elements popped.
- since: 7.0.0
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      ...keys: RedisKey[],
      min: "MIN",
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.bzmpop
- Defined in utils/RedisCommander.ts:1176
bzmpop(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        keys: RedisKey[],
        min: "MIN",
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      keys: RedisKey[],
      min: "MIN",
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.bzmpop
- Defined in utils/RedisCommander.ts:1185
bzmpop(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        ...keys: RedisKey[],
        min: "MIN",
    ],
): Promise<unknown>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      ...keys: RedisKey[],
      min: "MIN",
  ]
Returns Promise<unknown>
Inherited from Commander.bzmpop
- Defined in utils/RedisCommander.ts:1194
bzmpop(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        keys: RedisKey[],
        min: "MIN",
    ],
): Promise<unknown>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      keys: RedisKey[],
      min: "MIN",
  ]
Returns Promise<unknown>
Inherited from Commander.bzmpop
- Defined in utils/RedisCommander.ts:1202
bzmpop(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        ...keys: RedisKey[],
        min: "MIN",
        countToken: "COUNT",
        count: string | number,
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      ...keys: RedisKey[],
      min: "MIN",
      countToken: "COUNT",
      count: string | number,
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.bzmpop
- Defined in utils/RedisCommander.ts:1210
bzmpop(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        keys: RedisKey[],
        min: "MIN",
        countToken: "COUNT",
        count: string | number,
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      keys: RedisKey[],
      min: "MIN",
      countToken: "COUNT",
      count: string | number,
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.bzmpop
- Defined in utils/RedisCommander.ts:1221
bzmpop(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        ...keys: RedisKey[],
        min: "MIN",
        countToken: "COUNT",
        count: string | number,
    ],
): Promise<unknown>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      ...keys: RedisKey[],
      min: "MIN",
      countToken: "COUNT",
      count: string | number,
  ]
Returns Promise<unknown>
Inherited from Commander.bzmpop
- Defined in utils/RedisCommander.ts:1232
bzmpop(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        keys: RedisKey[],
        min: "MIN",
        countToken: "COUNT",
        count: string | number,
    ],
): Promise<unknown>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      keys: RedisKey[],
      min: "MIN",
      countToken: "COUNT",
      count: string | number,
  ]
Returns Promise<unknown>
Inherited from Commander.bzmpop
- Defined in utils/RedisCommander.ts:1242
bzmpop(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        ...keys: RedisKey[],
        max: "MAX",
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      ...keys: RedisKey[],
      max: "MAX",
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.bzmpop
- Defined in utils/RedisCommander.ts:1252
bzmpop(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        keys: RedisKey[],
        max: "MAX",
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      keys: RedisKey[],
      max: "MAX",
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.bzmpop
- Defined in utils/RedisCommander.ts:1261
bzmpop(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        ...keys: RedisKey[],
        max: "MAX",
    ],
): Promise<unknown>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      ...keys: RedisKey[],
      max: "MAX",
  ]
Returns Promise<unknown>
Inherited from Commander.bzmpop
- Defined in utils/RedisCommander.ts:1270
bzmpop(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        keys: RedisKey[],
        max: "MAX",
    ],
): Promise<unknown>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      keys: RedisKey[],
      max: "MAX",
  ]
Returns Promise<unknown>
Inherited from Commander.bzmpop
- Defined in utils/RedisCommander.ts:1278
bzmpop(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        ...keys: RedisKey[],
        max: "MAX",
        countToken: "COUNT",
        count: string | number,
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      ...keys: RedisKey[],
      max: "MAX",
      countToken: "COUNT",
      count: string | number,
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.bzmpop
- Defined in utils/RedisCommander.ts:1286
bzmpop(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        keys: RedisKey[],
        max: "MAX",
        countToken: "COUNT",
        count: string | number,
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      keys: RedisKey[],
      max: "MAX",
      countToken: "COUNT",
      count: string | number,
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.bzmpop
- Defined in utils/RedisCommander.ts:1297
bzmpop(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        ...keys: RedisKey[],
        max: "MAX",
        countToken: "COUNT",
        count: string | number,
    ],
): Promise<unknown>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      ...keys: RedisKey[],
      max: "MAX",
      countToken: "COUNT",
      count: string | number,
  ]
Returns Promise<unknown>
Inherited from Commander.bzmpop
- Defined in utils/RedisCommander.ts:1308
bzmpop(
    ...args: [
        timeout: string
        | number,
        numkeys: string | number,
        keys: RedisKey[],
        max: "MAX",
        countToken: "COUNT",
        count: string | number,
    ],
): Promise<unknown>
Parameters
- ...args: [
      timeout: string
      | number,
      numkeys: string | number,
      keys: RedisKey[],
      max: "MAX",
      countToken: "COUNT",
      count: string | number,
  ]
Returns Promise<unknown>
Inherited from Commander.bzmpop
- Defined in utils/RedisCommander.ts:1318

bzpopmax

bzpopmax(
    ...args: [
        ...keys: RedisKey[],
        timeout: string
        | number,
        callback: Callback<[key: string, member: string, score: string]>,
    ],
): Promise<[key: string, member: string, score: string]>
Removes and returns the member with the highest score from one or more sorted sets. Blocks until a member available otherwise. Deletes the sorted set if the last element was popped.
- group: sorted-set
- complexity: O(log(N)) with N being the number of elements in the sorted set.
- since: 5.0.0
Parameters
- ...args: [
      ...keys: RedisKey[],
      timeout: string
      | number,
      callback: Callback<[key: string, member: string, score: string]>,
  ]
Returns Promise<[key: string, member: string, score: string]>
Inherited from Commander.bzpopmax
- Defined in utils/RedisCommander.ts:1335
bzpopmax(
    ...args: [
        keys: RedisKey[],
        timeout: string
        | number,
        callback: Callback<[key: string, member: string, score: string]>,
    ],
): Promise<[key: string, member: string, score: string]>
Parameters
- ...args: [
      keys: RedisKey[],
      timeout: string
      | number,
      callback: Callback<[key: string, member: string, score: string]>,
  ]
Returns Promise<[key: string, member: string, score: string]>
Inherited from Commander.bzpopmax
- Defined in utils/RedisCommander.ts:1349
bzpopmax(
...args: [...keys: RedisKey[], timeout: string | number],
): Promise<[key: string, member: string, score: string]>
Parameters
- ...args: [...keys: RedisKey[], timeout: string | number]
Returns Promise<[key: string, member: string, score: string]>
Inherited from Commander.bzpopmax
- Defined in utils/RedisCommander.ts:1363
bzpopmax(
...args: [keys: RedisKey[], timeout: string | number],
): Promise<[key: string, member: string, score: string]>
Parameters
- ...args: [keys: RedisKey[], timeout: string | number]
Returns Promise<[key: string, member: string, score: string]>
Inherited from Commander.bzpopmax
- Defined in utils/RedisCommander.ts:1369

bzpopmaxBuffer

bzpopmaxBuffer(
    ...args: [
        ...keys: RedisKey[],
        timeout: string
        | number,
        callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>,
    ],
): Promise<[key: Buffer, member: Buffer, score: Buffer]>
Parameters
- ...args: [
      ...keys: RedisKey[],
      timeout: string
      | number,
      callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>,
  ]
Returns Promise<[key: Buffer, member: Buffer, score: Buffer]>
Inherited from Commander.bzpopmaxBuffer
- Defined in utils/RedisCommander.ts:1342
bzpopmaxBuffer(
    ...args: [
        keys: RedisKey[],
        timeout: string
        | number,
        callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>,
    ],
): Promise<[key: Buffer, member: Buffer, score: Buffer]>
Parameters
- ...args: [
      keys: RedisKey[],
      timeout: string
      | number,
      callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>,
  ]
Returns Promise<[key: Buffer, member: Buffer, score: Buffer]>
Inherited from Commander.bzpopmaxBuffer
- Defined in utils/RedisCommander.ts:1356
bzpopmaxBuffer(
...args: [...keys: RedisKey[], timeout: string | number],
): Promise<[key: Buffer, member: Buffer, score: Buffer]>
Parameters
- ...args: [...keys: RedisKey[], timeout: string | number]
Returns Promise<[key: Buffer, member: Buffer, score: Buffer]>
Inherited from Commander.bzpopmaxBuffer
- Defined in utils/RedisCommander.ts:1366
bzpopmaxBuffer(
...args: [keys: RedisKey[], timeout: string | number],
): Promise<[key: Buffer, member: Buffer, score: Buffer]>
Parameters
- ...args: [keys: RedisKey[], timeout: string | number]
Returns Promise<[key: Buffer, member: Buffer, score: Buffer]>
Inherited from Commander.bzpopmaxBuffer
- Defined in utils/RedisCommander.ts:1372

bzpopmin

bzpopmin(
    ...args: [
        ...keys: RedisKey[],
        timeout: string
        | number,
        callback: Callback<[key: string, member: string, score: string]>,
    ],
): Promise<[key: string, member: string, score: string]>
Removes and returns the member with the lowest score from one or more sorted sets. Blocks until a member is available otherwise. Deletes the sorted set if the last element was popped.
- group: sorted-set
- complexity: O(log(N)) with N being the number of elements in the sorted set.
- since: 5.0.0
Parameters
- ...args: [
      ...keys: RedisKey[],
      timeout: string
      | number,
      callback: Callback<[key: string, member: string, score: string]>,
  ]
Returns Promise<[key: string, member: string, score: string]>
Inherited from Commander.bzpopmin
- Defined in utils/RedisCommander.ts:1382
bzpopmin(
    ...args: [
        keys: RedisKey[],
        timeout: string
        | number,
        callback: Callback<[key: string, member: string, score: string]>,
    ],
): Promise<[key: string, member: string, score: string]>
Parameters
- ...args: [
      keys: RedisKey[],
      timeout: string
      | number,
      callback: Callback<[key: string, member: string, score: string]>,
  ]
Returns Promise<[key: string, member: string, score: string]>
Inherited from Commander.bzpopmin
- Defined in utils/RedisCommander.ts:1396
bzpopmin(
...args: [...keys: RedisKey[], timeout: string | number],
): Promise<[key: string, member: string, score: string]>
Parameters
- ...args: [...keys: RedisKey[], timeout: string | number]
Returns Promise<[key: string, member: string, score: string]>
Inherited from Commander.bzpopmin
- Defined in utils/RedisCommander.ts:1410
bzpopmin(
...args: [keys: RedisKey[], timeout: string | number],
): Promise<[key: string, member: string, score: string]>
Parameters
- ...args: [keys: RedisKey[], timeout: string | number]
Returns Promise<[key: string, member: string, score: string]>
Inherited from Commander.bzpopmin
- Defined in utils/RedisCommander.ts:1416

bzpopminBuffer

bzpopminBuffer(
    ...args: [
        ...keys: RedisKey[],
        timeout: string
        | number,
        callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>,
    ],
): Promise<[key: Buffer, member: Buffer, score: Buffer]>
Parameters
- ...args: [
      ...keys: RedisKey[],
      timeout: string
      | number,
      callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>,
  ]
Returns Promise<[key: Buffer, member: Buffer, score: Buffer]>
Inherited from Commander.bzpopminBuffer
- Defined in utils/RedisCommander.ts:1389
bzpopminBuffer(
    ...args: [
        keys: RedisKey[],
        timeout: string
        | number,
        callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>,
    ],
): Promise<[key: Buffer, member: Buffer, score: Buffer]>
Parameters
- ...args: [
      keys: RedisKey[],
      timeout: string
      | number,
      callback: Callback<[key: Buffer, member: Buffer, score: Buffer]>,
  ]
Returns Promise<[key: Buffer, member: Buffer, score: Buffer]>
Inherited from Commander.bzpopminBuffer
- Defined in utils/RedisCommander.ts:1403
bzpopminBuffer(
...args: [...keys: RedisKey[], timeout: string | number],
): Promise<[key: Buffer, member: Buffer, score: Buffer]>
Parameters
- ...args: [...keys: RedisKey[], timeout: string | number]
Returns Promise<[key: Buffer, member: Buffer, score: Buffer]>
Inherited from Commander.bzpopminBuffer
- Defined in utils/RedisCommander.ts:1413
bzpopminBuffer(
...args: [keys: RedisKey[], timeout: string | number],
): Promise<[key: Buffer, member: Buffer, score: Buffer]>
Parameters
- ...args: [keys: RedisKey[], timeout: string | number]
Returns Promise<[key: Buffer, member: Buffer, score: Buffer]>
Inherited from Commander.bzpopminBuffer
- Defined in utils/RedisCommander.ts:1419

call

call(command: string, callback?: Callback<unknown>): Promise<unknown>
Call arbitrary commands.

redis.call('set', 'foo', 'bar') is the same as redis.set('foo', 'bar'), so the only case you need to use this method is when the command is not supported by ioredis.
```
redis.call('set', 'foo', 'bar');
redis.call('get', 'foo', (err, value) => {
  // value === 'bar'
});
```
Parameters
- command: string
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.call
- Defined in utils/RedisCommander.ts:45
call(
    command: string,
    args: (string | number | Buffer)[],
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- command: string
- args: (string | number | Buffer)[]
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.call
- Defined in utils/RedisCommander.ts:46
call(
    ...args: [
        command: string,
        ...args: (string | number | Buffer)[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      command: string,
      ...args: (string | number | Buffer)[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.call
- Defined in utils/RedisCommander.ts:51
call(
...args: [command: string, ...args: (string | number | Buffer)[]],
): Promise<unknown>
Parameters
- ...args: [command: string, ...args: (string | number | Buffer)[]]
Returns Promise<unknown>
Inherited from Commander.call
- Defined in utils/RedisCommander.ts:58

callBuffer

callBuffer(command: string, callback?: Callback<unknown>): Promise<unknown>
Parameters
- command: string
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.callBuffer
- Defined in utils/RedisCommander.ts:61
callBuffer(
    command: string,
    args: (string | number | Buffer)[],
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- command: string
- args: (string | number | Buffer)[]
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.callBuffer
- Defined in utils/RedisCommander.ts:65
callBuffer(
    ...args: [
        command: string,
        ...args: (string | number | Buffer)[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      command: string,
      ...args: (string | number | Buffer)[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.callBuffer
- Defined in utils/RedisCommander.ts:70
callBuffer(
...args: [command: string, ...args: (string | number | Buffer)[]],
): Promise<unknown>
Parameters
- ...args: [command: string, ...args: (string | number | Buffer)[]]
Returns Promise<unknown>
Inherited from Commander.callBuffer
- Defined in utils/RedisCommander.ts:77

client

client(
    subcommand: "CACHING",
    yes: "YES",
    callback?: Callback<"OK">,
): Promise<"OK">
Instructs the server whether to track the keys in the next request.
- group: connection
- complexity: O(1)
- since: 6.0.0
Parameters
- subcommand: "CACHING"
- yes: "YES"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1429
client(
    subcommand: "CACHING",
    no: "NO",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- subcommand: "CACHING"
- no: "NO"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1434
client(
    ...args: [
        subcommand: "CAPA",
        ...capabilities: (string | Buffer)[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
A client claims its capability.
- group: connection
- complexity: O(1)
- since: 8.0.0
Parameters
- ...args: [
      subcommand: "CAPA",
      ...capabilities: (string | Buffer)[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1446
client(
...args: [subcommand: "CAPA", ...capabilities: (string | Buffer)[]],
): Promise<unknown>
Parameters
- ...args: [subcommand: "CAPA", ...capabilities: (string | Buffer)[]]
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1453
client(subcommand: "GETNAME", callback?: Callback<string>): Promise<string>
Returns the name of the connection.
- group: connection
- complexity: O(1)
- since: 2.6.9
Parameters
- subcommand: "GETNAME"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1463
client(subcommand: "GETREDIR", callback?: Callback<number>): Promise<number>
Returns the client ID to which the connection's tracking notifications are redirected.
- group: connection
- complexity: O(1)
- since: 6.0.0
Parameters
- subcommand: "GETREDIR"
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1478
client(subcommand: "HELP", callback?: Callback<unknown>): Promise<unknown>
Returns helpful text about the different subcommands.
- group: connection
- complexity: O(1)
- since: 5.0.0
Parameters
- subcommand: "HELP"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1489
client(subcommand: "ID", callback?: Callback<number>): Promise<number>
Returns the unique client ID of the connection.
- group: connection
- complexity: O(1)
- since: 5.0.0
Parameters
- subcommand: "ID"
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1500
client(subcommand: "INFO", callback?: Callback<string>): Promise<string>
Returns information about the connection.
- group: connection
- complexity: O(1)
- since: 6.2.0
Parameters
- subcommand: "INFO"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1511
client(
    subcommand: "KILL",
    oldFormat: string | Buffer,
    callback?: Callback<unknown>,
): Promise<unknown>
Terminates open connections.
- group: connection
- complexity: O(N) where N is the number of client connections
- since: 2.4.0
Parameters
- subcommand: "KILL"
- oldFormat: string | Buffer
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1526
client(subcommand: "KILL", callback?: Callback<unknown>): Promise<unknown>
Parameters
- subcommand: "KILL"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1531
client(
    subcommand: "KILL",
    clientIdToken: "ID",
    clientId: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "KILL"
- clientIdToken: "ID"
- clientId: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1535
client(subcommand: "KILL", callback?: Callback<unknown>): Promise<unknown>
Parameters
- subcommand: "KILL"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1541
client(
    subcommand: "KILL",
    type: "TYPE",
    normal: "NORMAL",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "KILL"
- type: "TYPE"
- normal: "NORMAL"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1545
client(
    subcommand: "KILL",
    type: "TYPE",
    master: "MASTER",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "KILL"
- type: "TYPE"
- master: "MASTER"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1551
client(
    subcommand: "KILL",
    type: "TYPE",
    primary: "PRIMARY",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "KILL"
- type: "TYPE"
- primary: "PRIMARY"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1557
client(
    subcommand: "KILL",
    type: "TYPE",
    slave: "SLAVE",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "KILL"
- type: "TYPE"
- slave: "SLAVE"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1563
client(
    subcommand: "KILL",
    type: "TYPE",
    replica: "REPLICA",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "KILL"
- type: "TYPE"
- replica: "REPLICA"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1569
client(
    subcommand: "KILL",
    type: "TYPE",
    pubsub: "PUBSUB",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "KILL"
- type: "TYPE"
- pubsub: "PUBSUB"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1575
client(subcommand: "KILL", callback?: Callback<unknown>): Promise<unknown>
Parameters
- subcommand: "KILL"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1581
client(
    subcommand: "KILL",
    usernameToken: "USER",
    username: string | Buffer,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "KILL"
- usernameToken: "USER"
- username: string | Buffer
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1585
client(subcommand: "KILL", callback?: Callback<unknown>): Promise<unknown>
Parameters
- subcommand: "KILL"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1591
client(
    subcommand: "KILL",
    addrToken: "ADDR",
    addr: string | Buffer,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "KILL"
- addrToken: "ADDR"
- addr: string | Buffer
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1595
client(subcommand: "KILL", callback?: Callback<unknown>): Promise<unknown>
Parameters
- subcommand: "KILL"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1601
client(
    subcommand: "KILL",
    laddrToken: "LADDR",
    laddr: string | Buffer,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "KILL"
- laddrToken: "LADDR"
- laddr: string | Buffer
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1605
client(subcommand: "KILL", callback?: Callback<unknown>): Promise<unknown>
Parameters
- subcommand: "KILL"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1611
client(
    subcommand: "KILL",
    skipme: "SKIPME",
    yes: "YES",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "KILL"
- skipme: "SKIPME"
- yes: "YES"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1615
client(
    subcommand: "KILL",
    skipme: "SKIPME",
    no: "NO",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "KILL"
- skipme: "SKIPME"
- no: "NO"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1621
client(subcommand: "KILL", callback?: Callback<unknown>): Promise<unknown>
Parameters
- subcommand: "KILL"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1627
client(
    subcommand: "KILL",
    maxageToken: "MAXAGE",
    maxage: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "KILL"
- maxageToken: "MAXAGE"
- maxage: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1631
client(subcommand: "LIST", callback?: Callback<unknown>): Promise<unknown>
Lists open connections.
- group: connection
- complexity: O(N) where N is the number of client connections
- since: 2.4.0
Parameters
- subcommand: "LIST"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1644
client(
    ...args: [
        subcommand: "LIST",
        clientIdToken: "ID",
        ...clientIds: (string | number)[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      subcommand: "LIST",
      clientIdToken: "ID",
      ...clientIds: (string | number)[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1648
client(
    ...args: [
        subcommand: "LIST",
        clientIdToken: "ID",
        ...clientIds: (string | number)[],
    ],
): Promise<unknown>
Parameters
- ...args: [subcommand: "LIST", clientIdToken: "ID", ...clientIds: (string | number)[]]
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1656
client(
    subcommand: "LIST",
    type: "TYPE",
    normal: "NORMAL",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "LIST"
- type: "TYPE"
- normal: "NORMAL"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1663
client(
    ...args: [
        subcommand: "LIST",
        type: "TYPE",
        normal: "NORMAL",
        clientIdToken: "ID",
        ...clientIds: (string | number)[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      subcommand: "LIST",
      type: "TYPE",
      normal: "NORMAL",
      clientIdToken: "ID",
      ...clientIds: (string | number)[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1669
client(
    ...args: [
        subcommand: "LIST",
        type: "TYPE",
        normal: "NORMAL",
        clientIdToken: "ID",
        ...clientIds: (string | number)[],
    ],
): Promise<unknown>
Parameters
- ...args: [
      subcommand: "LIST",
      type: "TYPE",
      normal: "NORMAL",
      clientIdToken: "ID",
      ...clientIds: (string | number)[],
  ]
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1679
client(
    subcommand: "LIST",
    type: "TYPE",
    master: "MASTER",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "LIST"
- type: "TYPE"
- master: "MASTER"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1688
client(
    ...args: [
        subcommand: "LIST",
        type: "TYPE",
        master: "MASTER",
        clientIdToken: "ID",
        ...clientIds: (string | number)[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      subcommand: "LIST",
      type: "TYPE",
      master: "MASTER",
      clientIdToken: "ID",
      ...clientIds: (string | number)[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1694
client(
    ...args: [
        subcommand: "LIST",
        type: "TYPE",
        master: "MASTER",
        clientIdToken: "ID",
        ...clientIds: (string | number)[],
    ],
): Promise<unknown>
Parameters
- ...args: [
      subcommand: "LIST",
      type: "TYPE",
      master: "MASTER",
      clientIdToken: "ID",
      ...clientIds: (string | number)[],
  ]
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1704
client(
    subcommand: "LIST",
    type: "TYPE",
    replica: "REPLICA",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "LIST"
- type: "TYPE"
- replica: "REPLICA"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1713
client(
    ...args: [
        subcommand: "LIST",
        type: "TYPE",
        replica: "REPLICA",
        clientIdToken: "ID",
        ...clientIds: (string | number)[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      subcommand: "LIST",
      type: "TYPE",
      replica: "REPLICA",
      clientIdToken: "ID",
      ...clientIds: (string | number)[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1719
client(
    ...args: [
        subcommand: "LIST",
        type: "TYPE",
        replica: "REPLICA",
        clientIdToken: "ID",
        ...clientIds: (string | number)[],
    ],
): Promise<unknown>
Parameters
- ...args: [
      subcommand: "LIST",
      type: "TYPE",
      replica: "REPLICA",
      clientIdToken: "ID",
      ...clientIds: (string | number)[],
  ]
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1729
client(
    subcommand: "LIST",
    type: "TYPE",
    pubsub: "PUBSUB",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "LIST"
- type: "TYPE"
- pubsub: "PUBSUB"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1738
client(
    ...args: [
        subcommand: "LIST",
        type: "TYPE",
        pubsub: "PUBSUB",
        clientIdToken: "ID",
        ...clientIds: (string | number)[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      subcommand: "LIST",
      type: "TYPE",
      pubsub: "PUBSUB",
      clientIdToken: "ID",
      ...clientIds: (string | number)[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1744
client(
    ...args: [
        subcommand: "LIST",
        type: "TYPE",
        pubsub: "PUBSUB",
        clientIdToken: "ID",
        ...clientIds: (string | number)[],
    ],
): Promise<unknown>
Parameters
- ...args: [
      subcommand: "LIST",
      type: "TYPE",
      pubsub: "PUBSUB",
      clientIdToken: "ID",
      ...clientIds: (string | number)[],
  ]
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1754
client(
    subcommand: "NO-EVICT",
    on: "ON",
    callback?: Callback<unknown>,
): Promise<unknown>
Sets the client eviction mode of the connection.
- group: connection
- complexity: O(1)
- since: 7.0.0
Parameters
- subcommand: "NO-EVICT"
- on: "ON"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1770
client(
    subcommand: "NO-EVICT",
    off: "OFF",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "NO-EVICT"
- off: "OFF"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1775
client(
    subcommand: "NO-TOUCH",
    on: "ON",
    callback?: Callback<unknown>,
): Promise<unknown>
Controls whether commands sent by the client affect the LRU/LFU of accessed keys.
- group: connection
- complexity: O(1)
- since: 7.2.0
Parameters
- subcommand: "NO-TOUCH"
- on: "ON"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1787
client(
    subcommand: "NO-TOUCH",
    off: "OFF",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "NO-TOUCH"
- off: "OFF"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1792
client(
    subcommand: "PAUSE",
    timeout: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Suspends commands processing.
- group: connection
- complexity: O(1)
- since: 3.0.0
Parameters
- subcommand: "PAUSE"
- timeout: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1804
client(
    subcommand: "PAUSE",
    timeout: string | number,
    write: "WRITE",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- subcommand: "PAUSE"
- timeout: string | number
- write: "WRITE"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1809
client(
    subcommand: "PAUSE",
    timeout: string | number,
    all: "ALL",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- subcommand: "PAUSE"
- timeout: string | number
- all: "ALL"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1815
client(
    subcommand: "REPLY",
    on: "ON",
    callback?: Callback<unknown>,
): Promise<unknown>
Instructs the server whether to reply to commands.
- group: connection
- complexity: O(1)
- since: 3.2.0
Parameters
- subcommand: "REPLY"
- on: "ON"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1828
client(
    subcommand: "REPLY",
    off: "OFF",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "REPLY"
- off: "OFF"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1833
client(
    subcommand: "REPLY",
    skip: "SKIP",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "REPLY"
- skip: "SKIP"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1838
client(
    subcommand: "SETINFO",
    libnameToken: "LIB-NAME",
    libname: string | Buffer,
    callback?: Callback<string>,
): Promise<string>
Sets information specific to the client or connection.
- group: connection
- complexity: O(1)
- since: 7.2.0
Parameters
- subcommand: "SETINFO"
- libnameToken: "LIB-NAME"
- libname: string | Buffer
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1850
client(
    subcommand: "SETINFO",
    libverToken: "LIB-VER",
    libver: string | Buffer,
    callback?: Callback<string>,
): Promise<string>
Parameters
- subcommand: "SETINFO"
- libverToken: "LIB-VER"
- libver: string | Buffer
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1862
client(
    subcommand: "SETNAME",
    connectionName: string | Buffer,
    callback?: Callback<"OK">,
): Promise<"OK">
Sets the connection name.
- group: connection
- complexity: O(1)
- since: 2.6.9
Parameters
- subcommand: "SETNAME"
- connectionName: string | Buffer
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1881
client(
    ...args: [
        subcommand: "TRACKING",
        ...args: RedisValue[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Controls server-assisted client-side caching for the connection.
- group: connection
- complexity: O(1). Some options may introduce additional complexity.
- since: 6.0.0
Parameters
- ...args: [subcommand: "TRACKING", ...args: RedisValue[], callback: Callback<unknown>]
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1893
client(
...args: [subcommand: "TRACKING", ...args: RedisValue[]],
): Promise<unknown>
Parameters
- ...args: [subcommand: "TRACKING", ...args: RedisValue[]]
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1900
client(subcommand: "TRACKINGINFO", callback?: Callback<string>): Promise<string>
Returns information about server-assisted client-side caching for the connection.
- group: connection
- complexity: O(1)
- since: 6.2.0
Parameters
- subcommand: "TRACKINGINFO"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1910
client(
    subcommand: "UNBLOCK",
    clientId: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Unblocks a client blocked by a blocking command from a different connection.
- group: connection
- complexity: O(log N) where N is the number of client connections
- since: 5.0.0
Parameters
- subcommand: "UNBLOCK"
- clientId: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1925
client(
    subcommand: "UNBLOCK",
    clientId: string | number,
    timeout: "TIMEOUT",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "UNBLOCK"
- clientId: string | number
- timeout: "TIMEOUT"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1930
client(
    subcommand: "UNBLOCK",
    clientId: string | number,
    error: "ERROR",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "UNBLOCK"
- clientId: string | number
- error: "ERROR"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1936
client(subcommand: "UNPAUSE", callback?: Callback<"OK">): Promise<"OK">
Resumes processing commands from paused clients.
- group: connection
- complexity: O(N) Where N is the number of paused clients
- since: 6.2.0
Parameters
- subcommand: "UNPAUSE"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.client
- Defined in utils/RedisCommander.ts:1949

clientBuffer

clientBuffer(
subcommand: "GETNAME",
callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- subcommand: "GETNAME"
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.clientBuffer
- Defined in utils/RedisCommander.ts:1467
clientBuffer(subcommand: "INFO", callback?: Callback<Buffer>): Promise<Buffer>
Parameters
- subcommand: "INFO"
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.clientBuffer
- Defined in utils/RedisCommander.ts:1515
clientBuffer(
    subcommand: "SETINFO",
    libnameToken: "LIB-NAME",
    libname: string | Buffer,
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- subcommand: "SETINFO"
- libnameToken: "LIB-NAME"
- libname: string | Buffer
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.clientBuffer
- Defined in utils/RedisCommander.ts:1856
clientBuffer(
    subcommand: "SETINFO",
    libverToken: "LIB-VER",
    libver: string | Buffer,
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- subcommand: "SETINFO"
- libverToken: "LIB-VER"
- libver: string | Buffer
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.clientBuffer
- Defined in utils/RedisCommander.ts:1868
clientBuffer(
subcommand: "TRACKINGINFO",
callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- subcommand: "TRACKINGINFO"
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.clientBuffer
- Defined in utils/RedisCommander.ts:1914

cluster

cluster(
    ...args: [
        subcommand: "ADDSLOTS",
        ...slots: (string | number)[],
        callback: Callback<
            [
                startSlotRange: number,
                endSlotRange: number,
                ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
            ][],
        >,
    ],
): Promise<
    [
        startSlotRange: number,
        endSlotRange: number,
        ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
    ][],
>
Assigns new hash slots to a node.
- group: cluster
- complexity: O(N) where N is the total number of hash slot arguments
- since: 3.0.0
Parameters
- ...args: [
      subcommand: "ADDSLOTS",
      ...slots: (string | number)[],
      callback: Callback<
          [
              startSlotRange: number,
              endSlotRange: number,
              ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
          ][],
      >,
  ]
Returns Promise<
    [
        startSlotRange: number,
        endSlotRange: number,
        ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
    ][],
>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:1960
cluster(
    ...args: [
        subcommand: "ADDSLOTS",
        slots: (string | number)[],
        callback: Callback<
            [
                startSlotRange: number,
                endSlotRange: number,
                ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
            ][],
        >,
    ],
): Promise<
    [
        startSlotRange: number,
        endSlotRange: number,
        ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
    ][],
>
Parameters
- ...args: [
      subcommand: "ADDSLOTS",
      slots: (string | number)[],
      callback: Callback<
          [
              startSlotRange: number,
              endSlotRange: number,
              ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
          ][],
      >,
  ]
Returns Promise<
    [
        startSlotRange: number,
        endSlotRange: number,
        ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
    ][],
>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:1985
cluster(
    ...args: [subcommand: "ADDSLOTS", ...slots: (string | number)[]],
): Promise<
    [
        startSlotRange: number,
        endSlotRange: number,
        ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
    ][],
>
Parameters
- ...args: [subcommand: "ADDSLOTS", ...slots: (string | number)[]]
Returns Promise<
    [
        startSlotRange: number,
        endSlotRange: number,
        ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
    ][],
>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2010
cluster(
    ...args: [subcommand: "ADDSLOTS", slots: (string | number)[]],
): Promise<
    [
        startSlotRange: number,
        endSlotRange: number,
        ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
    ][],
>
Parameters
- ...args: [subcommand: "ADDSLOTS", slots: (string | number)[]]
Returns Promise<
    [
        startSlotRange: number,
        endSlotRange: number,
        ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
    ][],
>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2020
cluster(
    ...args: [
        subcommand: "ADDSLOTSRANGE",
        ...ranges: (string | number)[],
        callback: Callback<
            [
                startSlotRange: number,
                endSlotRange: number,
                ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
            ][],
        >,
    ],
): Promise<
    [
        startSlotRange: number,
        endSlotRange: number,
        ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
    ][],
>
Assigns new hash slot ranges to a node.
- group: cluster
- complexity: O(N) where N is the total number of the slots between the start slot and end slot arguments.
- since: 7.0.0
Parameters
- ...args: [
      subcommand: "ADDSLOTSRANGE",
      ...ranges: (string | number)[],
      callback: Callback<
          [
              startSlotRange: number,
              endSlotRange: number,
              ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
          ][],
      >,
  ]
Returns Promise<
    [
        startSlotRange: number,
        endSlotRange: number,
        ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
    ][],
>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2037
cluster(
    ...args: [subcommand: "ADDSLOTSRANGE", ...ranges: (string | number)[]],
): Promise<
    [
        startSlotRange: number,
        endSlotRange: number,
        ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
    ][],
>
Parameters
- ...args: [subcommand: "ADDSLOTSRANGE", ...ranges: (string | number)[]]
Returns Promise<
    [
        startSlotRange: number,
        endSlotRange: number,
        ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
    ][],
>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2062
cluster(
subcommand: "BUMPEPOCH",
callback?: Callback<"BUMPED" | "STILL">,
): Promise<"BUMPED" | "STILL">
Advances the cluster config epoch.
- group: cluster
- complexity: O(1)
- since: 3.0.0
Parameters
- subcommand: "BUMPEPOCH"
- Optionalcallback: Callback<"BUMPED" | "STILL">
Returns Promise<"BUMPED" | "STILL">
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2079
cluster(
    subcommand: "COUNT-FAILURE-REPORTS",
    nodeId: string | number | Buffer,
    callback?: Callback<number>,
): Promise<number>
Returns the number of active failure reports active for a node.
- group: cluster
- complexity: O(N) where N is the number of failure reports
- since: 3.0.0
Parameters
- subcommand: "COUNT-FAILURE-REPORTS"
- nodeId: string | number | Buffer
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2090
cluster(
    subcommand: "COUNTKEYSINSLOT",
    slot: string | number,
    callback?: Callback<number>,
): Promise<number>
Returns the number of keys in a hash slot.
- group: cluster
- complexity: O(1)
- since: 3.0.0
Parameters
- subcommand: "COUNTKEYSINSLOT"
- slot: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2102
cluster(
    ...args: [
        subcommand: "DELSLOTS",
        ...slots: (string | number)[],
        callback: Callback<
            [
                startSlotRange: number,
                endSlotRange: number,
                ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
            ][],
        >,
    ],
): Promise<
    [
        startSlotRange: number,
        endSlotRange: number,
        ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
    ][],
>
Sets hash slots as unbound for a node.
- group: cluster
- complexity: O(N) where N is the total number of hash slot arguments
- since: 3.0.0
Parameters
- ...args: [
      subcommand: "DELSLOTS",
      ...slots: (string | number)[],
      callback: Callback<
          [
              startSlotRange: number,
              endSlotRange: number,
              ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
          ][],
      >,
  ]
Returns Promise<
    [
        startSlotRange: number,
        endSlotRange: number,
        ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
    ][],
>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2114
cluster(
    ...args: [
        subcommand: "DELSLOTS",
        slots: (string | number)[],
        callback: Callback<
            [
                startSlotRange: number,
                endSlotRange: number,
                ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
            ][],
        >,
    ],
): Promise<
    [
        startSlotRange: number,
        endSlotRange: number,
        ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
    ][],
>
Parameters
- ...args: [
      subcommand: "DELSLOTS",
      slots: (string | number)[],
      callback: Callback<
          [
              startSlotRange: number,
              endSlotRange: number,
              ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
          ][],
      >,
  ]
Returns Promise<
    [
        startSlotRange: number,
        endSlotRange: number,
        ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
    ][],
>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2139
cluster(
    ...args: [subcommand: "DELSLOTS", ...slots: (string | number)[]],
): Promise<
    [
        startSlotRange: number,
        endSlotRange: number,
        ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
    ][],
>
Parameters
- ...args: [subcommand: "DELSLOTS", ...slots: (string | number)[]]
Returns Promise<
    [
        startSlotRange: number,
        endSlotRange: number,
        ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
    ][],
>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2164
cluster(
    ...args: [subcommand: "DELSLOTS", slots: (string | number)[]],
): Promise<
    [
        startSlotRange: number,
        endSlotRange: number,
        ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
    ][],
>
Parameters
- ...args: [subcommand: "DELSLOTS", slots: (string | number)[]]
Returns Promise<
    [
        startSlotRange: number,
        endSlotRange: number,
        ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
    ][],
>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2174
cluster(
    ...args: [
        subcommand: "DELSLOTSRANGE",
        ...ranges: (string | number)[],
        callback: Callback<
            [
                startSlotRange: number,
                endSlotRange: number,
                ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
            ][],
        >,
    ],
): Promise<
    [
        startSlotRange: number,
        endSlotRange: number,
        ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
    ][],
>
Sets hash slot ranges as unbound for a node.
- group: cluster
- complexity: O(N) where N is the total number of the slots between the start slot and end slot arguments.
- since: 7.0.0
Parameters
- ...args: [
      subcommand: "DELSLOTSRANGE",
      ...ranges: (string | number)[],
      callback: Callback<
          [
              startSlotRange: number,
              endSlotRange: number,
              ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
          ][],
      >,
  ]
Returns Promise<
    [
        startSlotRange: number,
        endSlotRange: number,
        ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
    ][],
>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2191
cluster(
    ...args: [subcommand: "DELSLOTSRANGE", ...ranges: (string | number)[]],
): Promise<
    [
        startSlotRange: number,
        endSlotRange: number,
        ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
    ][],
>
Parameters
- ...args: [subcommand: "DELSLOTSRANGE", ...ranges: (string | number)[]]
Returns Promise<
    [
        startSlotRange: number,
        endSlotRange: number,
        ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
    ][],
>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2216
cluster(subcommand: "FAILOVER", callback?: Callback<"OK">): Promise<"OK">
Forces a replica to perform a manual failover of its primary.
- group: cluster
- complexity: O(1)
- since: 3.0.0
Parameters
- subcommand: "FAILOVER"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2233
cluster(
    subcommand: "FAILOVER",
    force: "FORCE",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- subcommand: "FAILOVER"
- force: "FORCE"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2237
cluster(
    subcommand: "FAILOVER",
    takeover: "TAKEOVER",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- subcommand: "FAILOVER"
- takeover: "TAKEOVER"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2242
cluster(
    subcommand: "FLUSHSLOTS",
    callback?: Callback<
        [
            startSlotRange: number,
            endSlotRange: number,
            ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
        ][],
    >,
): Promise<
    [
        startSlotRange: number,
        endSlotRange: number,
        ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
    ][],
>
Deletes all slots information from a node.
- group: cluster
- complexity: O(1)
- since: 3.0.0
Parameters
- subcommand: "FLUSHSLOTS"
- Optionalcallback: Callback<
      [
          startSlotRange: number,
          endSlotRange: number,
          ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
      ][],
  >
Returns Promise<
    [
        startSlotRange: number,
        endSlotRange: number,
        ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
    ][],
>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2254
cluster(
    subcommand: "FORGET",
    nodeId: string | number | Buffer,
    callback?: Callback<"OK">,
): Promise<"OK">
Removes a node from the nodes table.
- group: cluster
- complexity: O(1)
- since: 3.0.0
Parameters
- subcommand: "FORGET"
- nodeId: string | number | Buffer
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2283
cluster(
    subcommand: "GETKEYSINSLOT",
    slot: string | number,
    count: string | number,
    callback?: Callback<string[]>,
): Promise<string[]>
Returns the key names in a hash slot.
- group: cluster
- complexity: O(N) where N is the number of requested keys
- since: 3.0.0
Parameters
- subcommand: "GETKEYSINSLOT"
- slot: string | number
- count: string | number
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2295
cluster(subcommand: "HELP", callback?: Callback<unknown>): Promise<unknown>
Returns helpful text about the different subcommands.
- group: cluster
- complexity: O(1)
- since: 5.0.0
Parameters
- subcommand: "HELP"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2308
cluster(subcommand: "INFO", callback?: Callback<string>): Promise<string>
Returns information about the state of a node.
- group: cluster
- complexity: O(1)
- since: 3.0.0
Parameters
- subcommand: "INFO"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2319
cluster(
    subcommand: "KEYSLOT",
    key: string | Buffer,
    callback?: Callback<number>,
): Promise<number>
Returns the hash slot for a key.
- group: cluster
- complexity: O(N) where N is the number of bytes in the key
- since: 3.0.0
Parameters
- subcommand: "KEYSLOT"
- key: string | Buffer
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2330
cluster(subcommand: "LINKS", callback?: Callback<unknown[]>): Promise<unknown[]>
Returns a list of all TCP links to and from peer nodes.
- group: cluster
- complexity: O(N) where N is the total number of Cluster nodes
- since: 7.0.0
Parameters
- subcommand: "LINKS"
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2342
cluster(
    subcommand: "MEET",
    ip: string | Buffer,
    port: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Forces a node to handshake with another node.
- group: cluster
- complexity: O(1)
- since: 3.0.0
Parameters
- subcommand: "MEET"
- ip: string | Buffer
- port: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2353
cluster(
    subcommand: "MEET",
    ip: string | Buffer,
    port: string | number,
    clusterBusPort: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- subcommand: "MEET"
- ip: string | Buffer
- port: string | number
- clusterBusPort: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2359
cluster(subcommand: "MYID", callback?: Callback<string>): Promise<string>
Returns the ID of a node.
- group: cluster
- complexity: O(1)
- since: 3.0.0
Parameters
- subcommand: "MYID"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2373
cluster(subcommand: "MYSHARDID", callback?: Callback<unknown>): Promise<unknown>
Returns the shard ID of a node.
- group: cluster
- complexity: O(1)
- since: 7.2.0
Parameters
- subcommand: "MYSHARDID"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2384
cluster(subcommand: "NODES", callback?: Callback<unknown>): Promise<unknown>
Returns the cluster configuration for a node.
- group: cluster
- complexity: O(N) where N is the total number of Cluster nodes
- since: 3.0.0
Parameters
- subcommand: "NODES"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2395
cluster(
    subcommand: "REPLICAS",
    nodeId: string | number | Buffer,
    callback?: Callback<unknown>,
): Promise<unknown>
Lists the replica nodes of a primary node.
- group: cluster
- complexity: O(N) where N is the number of replicas.
- since: 5.0.0
Parameters
- subcommand: "REPLICAS"
- nodeId: string | number | Buffer
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2406
cluster(
    subcommand: "REPLICATE",
    nodeId: string | number | Buffer,
    callback?: Callback<"OK">,
): Promise<"OK">
Configure a node as replica of a primary node.
- group: cluster
- complexity: O(1)
- since: 3.0.0
Parameters
- subcommand: "REPLICATE"
- nodeId: string | number | Buffer
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2418
cluster(subcommand: "RESET", callback?: Callback<"OK">): Promise<"OK">
Resets a node.
- group: cluster
- complexity: O(N) where N is the number of known nodes. The command may execute a FLUSHALL as a side effect.
- since: 3.0.0
Parameters
- subcommand: "RESET"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2430
cluster(
    subcommand: "RESET",
    hard: "HARD",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- subcommand: "RESET"
- hard: "HARD"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2434
cluster(
    subcommand: "RESET",
    soft: "SOFT",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- subcommand: "RESET"
- soft: "SOFT"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2439
cluster(subcommand: "SAVECONFIG", callback?: Callback<"OK">): Promise<"OK">
Forces a node to save the cluster configuration to disk.
- group: cluster
- complexity: O(1)
- since: 3.0.0
Parameters
- subcommand: "SAVECONFIG"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2451
cluster(
    subcommand: "SET-CONFIG-EPOCH",
    configEpoch: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Sets the configuration epoch for a new node.
- group: cluster
- complexity: O(1)
- since: 3.0.0
Parameters
- subcommand: "SET-CONFIG-EPOCH"
- configEpoch: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2462
cluster(
    subcommand: "SETSLOT",
    slot: string | number,
    importingToken: "IMPORTING",
    importing: string | Buffer,
    callback?: Callback<"OK">,
): Promise<"OK">
Binds a hash slot to a node.
- group: cluster
- complexity: O(1)
- since: 3.0.0
Parameters
- subcommand: "SETSLOT"
- slot: string | number
- importingToken: "IMPORTING"
- importing: string | Buffer
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2474
cluster(
    subcommand: "SETSLOT",
    slot: string | number,
    importingToken: "IMPORTING",
    importing: string | Buffer,
    timeoutToken: "TIMEOUT",
    timeout: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- subcommand: "SETSLOT"
- slot: string | number
- importingToken: "IMPORTING"
- importing: string | Buffer
- timeoutToken: "TIMEOUT"
- timeout: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2481
cluster(
    subcommand: "SETSLOT",
    slot: string | number,
    migratingToken: "MIGRATING",
    migrating: string | Buffer,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- subcommand: "SETSLOT"
- slot: string | number
- migratingToken: "MIGRATING"
- migrating: string | Buffer
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2490
cluster(
    subcommand: "SETSLOT",
    slot: string | number,
    migratingToken: "MIGRATING",
    migrating: string | Buffer,
    timeoutToken: "TIMEOUT",
    timeout: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- subcommand: "SETSLOT"
- slot: string | number
- migratingToken: "MIGRATING"
- migrating: string | Buffer
- timeoutToken: "TIMEOUT"
- timeout: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2497
cluster(
    subcommand: "SETSLOT",
    slot: string | number,
    nodeToken: "NODE",
    node: string | Buffer,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- subcommand: "SETSLOT"
- slot: string | number
- nodeToken: "NODE"
- node: string | Buffer
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2506
cluster(
    subcommand: "SETSLOT",
    slot: string | number,
    nodeToken: "NODE",
    node: string | Buffer,
    timeoutToken: "TIMEOUT",
    timeout: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- subcommand: "SETSLOT"
- slot: string | number
- nodeToken: "NODE"
- node: string | Buffer
- timeoutToken: "TIMEOUT"
- timeout: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2513
cluster(
    subcommand: "SETSLOT",
    slot: string | number,
    stable: "STABLE",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- subcommand: "SETSLOT"
- slot: string | number
- stable: "STABLE"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2522
cluster(
    subcommand: "SETSLOT",
    slot: string | number,
    stable: "STABLE",
    timeoutToken: "TIMEOUT",
    timeout: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- subcommand: "SETSLOT"
- slot: string | number
- stable: "STABLE"
- timeoutToken: "TIMEOUT"
- timeout: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2528
cluster(subcommand: "SHARDS", callback?: Callback<unknown>): Promise<unknown>
Returns the mapping of cluster slots to shards.
- group: cluster
- complexity: O(N) where N is the total number of cluster nodes
- since: 7.0.0
Parameters
- subcommand: "SHARDS"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2543
cluster(
    subcommand: "SLAVES",
    nodeId: string | number | Buffer,
    callback?: Callback<unknown>,
): Promise<unknown>
Lists the replica nodes of a primary node.
- group: cluster
- complexity: O(N) where N is the number of replicas.
- since: 3.0.0
Parameters
- subcommand: "SLAVES"
- nodeId: string | number | Buffer
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2554
cluster(
    subcommand: "SLOT-STATS",
    slotsrangeToken: "SLOTSRANGE",
    startSlot: string | number,
    endSlot: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Return an array of slot usage statistics for slots assigned to the current node.
- group: cluster
- complexity: O(N) where N is the total number of slots based on arguments. O(N*log(N)) with ORDERBY subcommand.
- since: 8.0.0
Parameters
- subcommand: "SLOT-STATS"
- slotsrangeToken: "SLOTSRANGE"
- startSlot: string | number
- endSlot: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2566
cluster(
    subcommand: "SLOT-STATS",
    orderbyToken: "ORDERBY",
    metric: string | Buffer,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "SLOT-STATS"
- orderbyToken: "ORDERBY"
- metric: string | Buffer
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2573
cluster(
    subcommand: "SLOT-STATS",
    orderbyToken: "ORDERBY",
    metric: string | Buffer,
    asc: "ASC",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "SLOT-STATS"
- orderbyToken: "ORDERBY"
- metric: string | Buffer
- asc: "ASC"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2579
cluster(
    subcommand: "SLOT-STATS",
    orderbyToken: "ORDERBY",
    metric: string | Buffer,
    desc: "DESC",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "SLOT-STATS"
- orderbyToken: "ORDERBY"
- metric: string | Buffer
- desc: "DESC"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2586
cluster(
    subcommand: "SLOT-STATS",
    orderbyToken: "ORDERBY",
    metric: string | Buffer,
    limitToken: "LIMIT",
    limit: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "SLOT-STATS"
- orderbyToken: "ORDERBY"
- metric: string | Buffer
- limitToken: "LIMIT"
- limit: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2593
cluster(
    subcommand: "SLOT-STATS",
    orderbyToken: "ORDERBY",
    metric: string | Buffer,
    limitToken: "LIMIT",
    limit: string | number,
    asc: "ASC",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "SLOT-STATS"
- orderbyToken: "ORDERBY"
- metric: string | Buffer
- limitToken: "LIMIT"
- limit: string | number
- asc: "ASC"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2601
cluster(
    subcommand: "SLOT-STATS",
    orderbyToken: "ORDERBY",
    metric: string | Buffer,
    limitToken: "LIMIT",
    limit: string | number,
    desc: "DESC",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "SLOT-STATS"
- orderbyToken: "ORDERBY"
- metric: string | Buffer
- limitToken: "LIMIT"
- limit: string | number
- desc: "DESC"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2610
cluster(
    subcommand: "SLOTS",
    callback?: Callback<
        [
            startSlotRange: number,
            endSlotRange: number,
            ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
        ][],
    >,
): Promise<
    [
        startSlotRange: number,
        endSlotRange: number,
        ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
    ][],
>
Returns the mapping of cluster slots to nodes.
- group: cluster
- complexity: O(N) where N is the total number of Cluster nodes
- since: 3.0.0
Parameters
- subcommand: "SLOTS"
- Optionalcallback: Callback<
      [
          startSlotRange: number,
          endSlotRange: number,
          ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
      ][],
  >
Returns Promise<
    [
        startSlotRange: number,
        endSlotRange: number,
        ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][],
    ][],
>
Inherited from Commander.cluster
- Defined in utils/RedisCommander.ts:2626

command

command(subcommand: "COUNT", callback?: Callback<unknown[]>): Promise<unknown[]>
Returns a count of commands.
- group: server
- complexity: O(1)
- since: 2.8.13
Parameters
- subcommand: "COUNT"
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.command
- Defined in utils/RedisCommander.ts:2655
command(subcommand: "DOCS", callback?: Callback<unknown[]>): Promise<unknown[]>
Returns documentary information about one, multiple or all commands.
- group: server
- complexity: O(N) where N is the number of commands to look up
- since: 7.0.0
Parameters
- subcommand: "DOCS"
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.command
- Defined in utils/RedisCommander.ts:2666
command(
    ...args: [
        subcommand: "DOCS",
        ...commandNames: (string | Buffer)[],
        callback: Callback<unknown[]>,
    ],
): Promise<unknown[]>
Parameters
- ...args: [
      subcommand: "DOCS",
      ...commandNames: (string | Buffer)[],
      callback: Callback<unknown[]>,
  ]
Returns Promise<unknown[]>
Inherited from Commander.command
- Defined in utils/RedisCommander.ts:2670
command(
...args: [subcommand: "DOCS", ...commandNames: (string | Buffer)[]],
): Promise<unknown[]>
Parameters
- ...args: [subcommand: "DOCS", ...commandNames: (string | Buffer)[]]
Returns Promise<unknown[]>
Inherited from Commander.command
- Defined in utils/RedisCommander.ts:2677
command(
    subcommand: "GETKEYS",
    command: string | Buffer,
    callback?: Callback<unknown[]>,
): Promise<unknown[]>
Extracts the key names from an arbitrary command.
- group: server
- complexity: O(N) where N is the number of arguments to the command
- since: 2.8.13
Parameters
- subcommand: "GETKEYS"
- command: string | Buffer
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.command
- Defined in utils/RedisCommander.ts:2687
command(
    ...args: [
        subcommand: "GETKEYS",
        command: string
        | Buffer,
        ...args: (string | number | Buffer)[],
        callback: Callback<unknown[]>,
    ],
): Promise<unknown[]>
Parameters
- ...args: [
      subcommand: "GETKEYS",
      command: string
      | Buffer,
      ...args: (string | number | Buffer)[],
      callback: Callback<unknown[]>,
  ]
Returns Promise<unknown[]>
Inherited from Commander.command
- Defined in utils/RedisCommander.ts:2692
command(
    ...args: [
        subcommand: "GETKEYS",
        command: string
        | Buffer,
        ...args: (string | number | Buffer)[],
    ],
): Promise<unknown[]>
Parameters
- ...args: [
      subcommand: "GETKEYS",
      command: string
      | Buffer,
      ...args: (string | number | Buffer)[],
  ]
Returns Promise<unknown[]>
Inherited from Commander.command
- Defined in utils/RedisCommander.ts:2700
command(
    subcommand: "GETKEYSANDFLAGS",
    command: string | Buffer,
    callback?: Callback<unknown[]>,
): Promise<unknown[]>
Extracts the key names and access flags for an arbitrary command.
- group: server
- complexity: O(N) where N is the number of arguments to the command
- since: 7.0.0
Parameters
- subcommand: "GETKEYSANDFLAGS"
- command: string | Buffer
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.command
- Defined in utils/RedisCommander.ts:2714
command(
    ...args: [
        subcommand: "GETKEYSANDFLAGS",
        command: string
        | Buffer,
        ...args: (string | number | Buffer)[],
        callback: Callback<unknown[]>,
    ],
): Promise<unknown[]>
Parameters
- ...args: [
      subcommand: "GETKEYSANDFLAGS",
      command: string
      | Buffer,
      ...args: (string | number | Buffer)[],
      callback: Callback<unknown[]>,
  ]
Returns Promise<unknown[]>
Inherited from Commander.command
- Defined in utils/RedisCommander.ts:2719
command(
    ...args: [
        subcommand: "GETKEYSANDFLAGS",
        command: string
        | Buffer,
        ...args: (string | number | Buffer)[],
    ],
): Promise<unknown[]>
Parameters
- ...args: [
      subcommand: "GETKEYSANDFLAGS",
      command: string
      | Buffer,
      ...args: (string | number | Buffer)[],
  ]
Returns Promise<unknown[]>
Inherited from Commander.command
- Defined in utils/RedisCommander.ts:2727
command(subcommand: "HELP", callback?: Callback<unknown[]>): Promise<unknown[]>
Returns helpful text about the different subcommands.
- group: server
- complexity: O(1)
- since: 5.0.0
Parameters
- subcommand: "HELP"
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.command
- Defined in utils/RedisCommander.ts:2741
command(subcommand: "INFO", callback?: Callback<unknown[]>): Promise<unknown[]>
Returns information about one, multiple or all commands.
- group: server
- complexity: O(N) where N is the number of commands to look up
- since: 2.8.13
Parameters
- subcommand: "INFO"
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.command
- Defined in utils/RedisCommander.ts:2752
command(
    ...args: [
        subcommand: "INFO",
        ...commandNames: (string | Buffer)[],
        callback: Callback<unknown[]>,
    ],
): Promise<unknown[]>
Parameters
- ...args: [
      subcommand: "INFO",
      ...commandNames: (string | Buffer)[],
      callback: Callback<unknown[]>,
  ]
Returns Promise<unknown[]>
Inherited from Commander.command
- Defined in utils/RedisCommander.ts:2756
command(
...args: [subcommand: "INFO", ...commandNames: (string | Buffer)[]],
): Promise<unknown[]>
Parameters
- ...args: [subcommand: "INFO", ...commandNames: (string | Buffer)[]]
Returns Promise<unknown[]>
Inherited from Commander.command
- Defined in utils/RedisCommander.ts:2763
command(subcommand: "LIST", callback?: Callback<unknown[]>): Promise<unknown[]>
Returns a list of command names.
- group: server
- complexity: O(N) where N is the total number of commands
- since: 7.0.0
Parameters
- subcommand: "LIST"
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.command
- Defined in utils/RedisCommander.ts:2773
command(
    subcommand: "LIST",
    filterby: "FILTERBY",
    moduleNameToken: "MODULE",
    moduleName: string | Buffer,
    callback?: Callback<unknown[]>,
): Promise<unknown[]>
Parameters
- subcommand: "LIST"
- filterby: "FILTERBY"
- moduleNameToken: "MODULE"
- moduleName: string | Buffer
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.command
- Defined in utils/RedisCommander.ts:2777
command(
    subcommand: "LIST",
    filterby: "FILTERBY",
    categoryToken: "ACLCAT",
    category: string | Buffer,
    callback?: Callback<unknown[]>,
): Promise<unknown[]>
Parameters
- subcommand: "LIST"
- filterby: "FILTERBY"
- categoryToken: "ACLCAT"
- category: string | Buffer
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.command
- Defined in utils/RedisCommander.ts:2784
command(
    subcommand: "LIST",
    filterby: "FILTERBY",
    patternToken: "PATTERN",
    pattern: string,
    callback?: Callback<unknown[]>,
): Promise<unknown[]>
Parameters
- subcommand: "LIST"
- filterby: "FILTERBY"
- patternToken: "PATTERN"
- pattern: string
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.command
- Defined in utils/RedisCommander.ts:2791

config

config(
    ...args: [
        subcommand: "GET",
        ...parameters: (string | Buffer)[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Returns the effective values of configuration parameters.
- group: server
- complexity: O(N) when N is the number of configuration parameters provided
- since: 2.0.0
Parameters
- ...args: [
      subcommand: "GET",
      ...parameters: (string | Buffer)[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.config
- Defined in utils/RedisCommander.ts:2805
config(
...args: [subcommand: "GET", ...parameters: (string | Buffer)[]],
): Promise<unknown>
Parameters
- ...args: [subcommand: "GET", ...parameters: (string | Buffer)[]]
Returns Promise<unknown>
Inherited from Commander.config
- Defined in utils/RedisCommander.ts:2812
config(subcommand: "HELP", callback?: Callback<unknown>): Promise<unknown>
Returns helpful text about the different subcommands.
- group: server
- complexity: O(1)
- since: 5.0.0
Parameters
- subcommand: "HELP"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.config
- Defined in utils/RedisCommander.ts:2822
config(subcommand: "RESETSTAT", callback?: Callback<unknown>): Promise<unknown>
Resets the server's statistics.
- group: server
- complexity: O(1)
- since: 2.0.0
Parameters
- subcommand: "RESETSTAT"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.config
- Defined in utils/RedisCommander.ts:2833
config(subcommand: "REWRITE", callback?: Callback<unknown>): Promise<unknown>
Persists the effective configuration to file.
- group: server
- complexity: O(1)
- since: 2.8.0
Parameters
- subcommand: "REWRITE"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.config
- Defined in utils/RedisCommander.ts:2844
config(
    ...args: [
        subcommand: "SET",
        ...data: (string | number | Buffer)[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Sets configuration parameters in-flight.
- group: server
- complexity: O(N) when N is the number of configuration parameters provided
- since: 2.0.0
Parameters
- ...args: [
      subcommand: "SET",
      ...data: (string | number | Buffer)[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.config
- Defined in utils/RedisCommander.ts:2855
config(
...args: [subcommand: "SET", ...data: (string | number | Buffer)[]],
): Promise<unknown>
Parameters
- ...args: [subcommand: "SET", ...data: (string | number | Buffer)[]]
Returns Promise<unknown>
Inherited from Commander.config
- Defined in utils/RedisCommander.ts:2862

connect

connect(): Promise<void>
Connect to a cluster

Returns Promise<void>
- Defined in cluster/index.ts:182

copy

copy(
    source: RedisKey,
    destination: RedisKey,
    callback?: Callback<number>,
): Promise<number>
Copies the value of a key to a new key.
- group: generic
- complexity: O(N) worst case for collections, where N is the number of nested items. O(1) for string values.
- since: 6.2.0
Parameters
- source: RedisKey
- destination: RedisKey
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.copy
- Defined in utils/RedisCommander.ts:2872
copy(
    source: RedisKey,
    destination: RedisKey,
    replace: "REPLACE",
    callback?: Callback<number>,
): Promise<number>
Parameters
- source: RedisKey
- destination: RedisKey
- replace: "REPLACE"
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.copy
- Defined in utils/RedisCommander.ts:2877
copy(
    source: RedisKey,
    destination: RedisKey,
    destinationDbToken: "DB",
    destinationDb: string | number,
    callback?: Callback<number>,
): Promise<number>
Parameters
- source: RedisKey
- destination: RedisKey
- destinationDbToken: "DB"
- destinationDb: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.copy
- Defined in utils/RedisCommander.ts:2883
copy(
    source: RedisKey,
    destination: RedisKey,
    destinationDbToken: "DB",
    destinationDb: string | number,
    replace: "REPLACE",
    callback?: Callback<number>,
): Promise<number>
Parameters
- source: RedisKey
- destination: RedisKey
- destinationDbToken: "DB"
- destinationDb: string | number
- replace: "REPLACE"
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.copy
- Defined in utils/RedisCommander.ts:2890

createBuiltinCommand

createBuiltinCommand(commandName: string): { buffer: any; string: any }
Create a builtin command
Parameters
- commandName: string
Returns { buffer: any; string: any }
Inherited from Commander.createBuiltinCommand
- Defined in utils/Commander.ts:40

dbsize

dbsize(callback?: Callback<number>): Promise<number>
Returns the number of keys in the database.
- group: server
- complexity: O(1)
- since: 1.0.0
Parameters
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.dbsize
- Defined in utils/RedisCommander.ts:2905

debug

debug(subcommand: string, callback?: Callback<unknown>): Promise<unknown>
A container for debugging commands.
- group: server
- complexity: Depends on subcommand.
- since: 1.0.0
Parameters
- subcommand: string
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.debug
- Defined in utils/RedisCommander.ts:2913
debug(
    ...args: [
        subcommand: string,
        ...args: (string | number | Buffer)[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      subcommand: string,
      ...args: (string | number | Buffer)[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.debug
- Defined in utils/RedisCommander.ts:2917
debug(
...args: [subcommand: string, ...args: (string | number | Buffer)[]],
): Promise<unknown>
Parameters
- ...args: [subcommand: string, ...args: (string | number | Buffer)[]]
Returns Promise<unknown>
Inherited from Commander.debug
- Defined in utils/RedisCommander.ts:2924

decr

decr(key: RedisKey, callback?: Callback<number>): Promise<number>
Decrements the integer value of a key by one. Uses 0 as initial value if the key doesn't exist.
- group: string
- complexity: O(1)
- since: 1.0.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.decr
- Defined in utils/RedisCommander.ts:2934

decrby

decrby(
    key: RedisKey,
    decrement: string | number,
    callback?: Callback<number>,
): Promise<number>
Decrements a number from the integer value of a key. Uses 0 as initial value if the key doesn't exist.
- group: string
- complexity: O(1)
- since: 1.0.0
Parameters
- key: RedisKey
- decrement: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.decrby
- Defined in utils/RedisCommander.ts:2942

defineCommand

defineCommand(
name: string,
definition: { lua: string; numberOfKeys?: number; readOnly?: boolean },
): void
Define a custom command using lua script
Parameters
- name: string
- definition: { lua: string; numberOfKeys?: number; readOnly?: boolean }
Returns void
Inherited from Commander.defineCommand
- Defined in utils/Commander.ts:63

del

del(...args: [...keys: RedisKey[], callback: Callback<number>]): Promise<number>
Deletes one or more keys.
- group: generic
- complexity: O(N) where N is the number of keys that will be removed. When a key to remove holds a value other than a string, the individual complexity for this key is O(M) where M is the number of elements in the list, set, sorted set or hash. Removing a single key that holds a string value is O(1).
- since: 1.0.0
Parameters
- ...args: [...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Inherited from Commander.del
- Defined in utils/RedisCommander.ts:2954
del(...args: [keys: RedisKey[], callback: Callback<number>]): Promise<number>
Parameters
- ...args: [keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Inherited from Commander.del
- Defined in utils/RedisCommander.ts:2957
del(...args: RedisKey[]): Promise<number>
Parameters
- ...args: RedisKey[]
Returns Promise<number>
Inherited from Commander.del
- Defined in utils/RedisCommander.ts:2960
del(...args: [keys: RedisKey[]]): Promise<number>
Parameters
- ...args: [keys: RedisKey[]]
Returns Promise<number>
Inherited from Commander.del
- Defined in utils/RedisCommander.ts:2961

discard

discard(callback?: Callback<"OK">): Promise<"OK">
Discards a transaction.
- group: transactions
- complexity: O(N), when N is the number of queued commands
- since: 2.0.0
Parameters
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.discard
- Defined in utils/RedisCommander.ts:2969

disconnect

disconnect(reconnect?: boolean): void
Disconnect from every node in the cluster.
Parameters
- reconnect: boolean = false
Returns void
- Defined in cluster/index.ts:286

dump

dump(key: RedisKey, callback?: Callback<string>): Promise<string>
Returns a serialized representation of the value stored at a key.
- group: generic
- complexity: O(1) to access the key and additional O(NM) to serialize it, where N is the number of objects composing the value and M their average size. For small string values the time complexity is thus O(1)+O(1M) where M is small, so simply O(1).
- since: 2.6.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.dump
- Defined in utils/RedisCommander.ts:2977

dumpBuffer

dumpBuffer(key: RedisKey, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
- key: RedisKey
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.dumpBuffer
- Defined in utils/RedisCommander.ts:2978

duplicate

duplicate(overrideStartupNodes?: any[], overrideOptions?: {}): Cluster
Create a new instance with the same startup nodes and options as the current one.
Parameters
- overrideStartupNodes: any[] = []
- overrideOptions: {} = {}
Returns Cluster
Example
```
var cluster = new Redis.Cluster([{ host: "127.0.0.1", port: "30001" }]);
var anotherCluster = cluster.duplicate();
```
- Defined in cluster/index.ts:366

echo

echo(message: string | Buffer, callback?: Callback<string>): Promise<string>
Returns the given string.
- group: connection
- complexity: O(1)
- since: 1.0.0
Parameters
- message: string | Buffer
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.echo
- Defined in utils/RedisCommander.ts:2989

echoBuffer

echoBuffer(
message: string | Buffer,
callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- message: string | Buffer
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.echoBuffer
- Defined in utils/RedisCommander.ts:2993

eval

eval(
    script: string | Buffer,
    numkeys: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Executes a server-side Lua script.
- group: scripting
- complexity: Depends on the script that is executed.
- since: 2.6.0
Parameters
- script: string | Buffer
- numkeys: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.eval
- Defined in utils/RedisCommander.ts:3004
eval(
    ...args: [
        script: string
        | Buffer,
        numkeys: string | number,
        ...args: (string | number | Buffer)[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      script: string
      | Buffer,
      numkeys: string | number,
      ...args: (string | number | Buffer)[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.eval
- Defined in utils/RedisCommander.ts:3009
eval(
    ...args: [
        script: string
        | Buffer,
        numkeys: string | number,
        ...args: (string | number | Buffer)[],
    ],
): Promise<unknown>
Parameters
- ...args: [
      script: string
      | Buffer,
      numkeys: string | number,
      ...args: (string | number | Buffer)[],
  ]
Returns Promise<unknown>
Inherited from Commander.eval
- Defined in utils/RedisCommander.ts:3017
eval(
    ...args: [
        script: string
        | Buffer,
        numkeys: string | number,
        ...keys: RedisKey[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      script: string
      | Buffer,
      numkeys: string | number,
      ...keys: RedisKey[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.eval
- Defined in utils/RedisCommander.ts:3024
eval(
    ...args: [
        script: string
        | Buffer,
        numkeys: string | number,
        keys: RedisKey[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      script: string
      | Buffer,
      numkeys: string | number,
      keys: RedisKey[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.eval
- Defined in utils/RedisCommander.ts:3032
eval(
    ...args: [
        script: string
        | Buffer,
        numkeys: string | number,
        ...keys: RedisKey[],
    ],
): Promise<unknown>
Parameters
- ...args: [script: string | Buffer, numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<unknown>
Inherited from Commander.eval
- Defined in utils/RedisCommander.ts:3040
eval(
    ...args: [
        script: string
        | Buffer,
        numkeys: string | number,
        keys: RedisKey[],
    ],
): Promise<unknown>
Parameters
- ...args: [script: string | Buffer, numkeys: string | number, keys: RedisKey[]]
Returns Promise<unknown>
Inherited from Commander.eval
- Defined in utils/RedisCommander.ts:3047
eval(
    ...args: [
        script: string
        | Buffer,
        numkeys: string | number,
        ...args: RedisValue[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      script: string
      | Buffer,
      numkeys: string | number,
      ...args: RedisValue[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.eval
- Defined in utils/RedisCommander.ts:3054
eval(
    ...args: [
        script: string
        | Buffer,
        numkeys: string | number,
        ...args: RedisValue[],
    ],
): Promise<unknown>
Parameters
- ...args: [script: string | Buffer, numkeys: string | number, ...args: RedisValue[]]
Returns Promise<unknown>
Inherited from Commander.eval
- Defined in utils/RedisCommander.ts:3062

eval_ro

eval_ro(
    script: string | Buffer,
    numkeys: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Executes a read-only server-side Lua script.
- group: scripting
- complexity: Depends on the script that is executed.
- since: 7.0.0
Parameters
- script: string | Buffer
- numkeys: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.eval_ro
- Defined in utils/RedisCommander.ts:3076
eval_ro(
    ...args: [
        script: string
        | Buffer,
        numkeys: string | number,
        ...args: (string | number | Buffer)[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      script: string
      | Buffer,
      numkeys: string | number,
      ...args: (string | number | Buffer)[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.eval_ro
- Defined in utils/RedisCommander.ts:3081
eval_ro(
    ...args: [
        script: string
        | Buffer,
        numkeys: string | number,
        ...args: (string | number | Buffer)[],
    ],
): Promise<unknown>
Parameters
- ...args: [
      script: string
      | Buffer,
      numkeys: string | number,
      ...args: (string | number | Buffer)[],
  ]
Returns Promise<unknown>
Inherited from Commander.eval_ro
- Defined in utils/RedisCommander.ts:3089
eval_ro(
    ...args: [
        script: string
        | Buffer,
        numkeys: string | number,
        ...keys: RedisKey[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      script: string
      | Buffer,
      numkeys: string | number,
      ...keys: RedisKey[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.eval_ro
- Defined in utils/RedisCommander.ts:3096
eval_ro(
    ...args: [
        script: string
        | Buffer,
        numkeys: string | number,
        keys: RedisKey[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      script: string
      | Buffer,
      numkeys: string | number,
      keys: RedisKey[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.eval_ro
- Defined in utils/RedisCommander.ts:3104
eval_ro(
    ...args: [
        script: string
        | Buffer,
        numkeys: string | number,
        ...keys: RedisKey[],
    ],
): Promise<unknown>
Parameters
- ...args: [script: string | Buffer, numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<unknown>
Inherited from Commander.eval_ro
- Defined in utils/RedisCommander.ts:3112
eval_ro(
    ...args: [
        script: string
        | Buffer,
        numkeys: string | number,
        keys: RedisKey[],
    ],
): Promise<unknown>
Parameters
- ...args: [script: string | Buffer, numkeys: string | number, keys: RedisKey[]]
Returns Promise<unknown>
Inherited from Commander.eval_ro
- Defined in utils/RedisCommander.ts:3119
eval_ro(
    ...args: [
        script: string
        | Buffer,
        numkeys: string | number,
        ...args: RedisValue[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      script: string
      | Buffer,
      numkeys: string | number,
      ...args: RedisValue[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.eval_ro
- Defined in utils/RedisCommander.ts:3126
eval_ro(
    ...args: [
        script: string
        | Buffer,
        numkeys: string | number,
        ...args: RedisValue[],
    ],
): Promise<unknown>
Parameters
- ...args: [script: string | Buffer, numkeys: string | number, ...args: RedisValue[]]
Returns Promise<unknown>
Inherited from Commander.eval_ro
- Defined in utils/RedisCommander.ts:3134

evalsha

evalsha(
    sha1: string | Buffer,
    numkeys: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Executes a server-side Lua script by SHA1 digest.
- group: scripting
- complexity: Depends on the script that is executed.
- since: 2.6.0
Parameters
- sha1: string | Buffer
- numkeys: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.evalsha
- Defined in utils/RedisCommander.ts:3148
evalsha(
    ...args: [
        sha1: string
        | Buffer,
        numkeys: string | number,
        ...args: (string | number | Buffer)[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      sha1: string
      | Buffer,
      numkeys: string | number,
      ...args: (string | number | Buffer)[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.evalsha
- Defined in utils/RedisCommander.ts:3153
evalsha(
    ...args: [
        sha1: string
        | Buffer,
        numkeys: string | number,
        ...args: (string | number | Buffer)[],
    ],
): Promise<unknown>
Parameters
- ...args: [
      sha1: string
      | Buffer,
      numkeys: string | number,
      ...args: (string | number | Buffer)[],
  ]
Returns Promise<unknown>
Inherited from Commander.evalsha
- Defined in utils/RedisCommander.ts:3161
evalsha(
    ...args: [
        sha1: string
        | Buffer,
        numkeys: string | number,
        ...keys: RedisKey[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      sha1: string
      | Buffer,
      numkeys: string | number,
      ...keys: RedisKey[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.evalsha
- Defined in utils/RedisCommander.ts:3168
evalsha(
    ...args: [
        sha1: string
        | Buffer,
        numkeys: string | number,
        keys: RedisKey[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      sha1: string
      | Buffer,
      numkeys: string | number,
      keys: RedisKey[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.evalsha
- Defined in utils/RedisCommander.ts:3176
evalsha(
    ...args: [
        sha1: string
        | Buffer,
        numkeys: string | number,
        ...keys: RedisKey[],
    ],
): Promise<unknown>
Parameters
- ...args: [sha1: string | Buffer, numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<unknown>
Inherited from Commander.evalsha
- Defined in utils/RedisCommander.ts:3184
evalsha(
    ...args: [
        sha1: string
        | Buffer,
        numkeys: string | number,
        keys: RedisKey[],
    ],
): Promise<unknown>
Parameters
- ...args: [sha1: string | Buffer, numkeys: string | number, keys: RedisKey[]]
Returns Promise<unknown>
Inherited from Commander.evalsha
- Defined in utils/RedisCommander.ts:3191
evalsha(
    ...args: [
        sha1: string
        | Buffer,
        numkeys: string | number,
        ...args: RedisValue[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      sha1: string
      | Buffer,
      numkeys: string | number,
      ...args: RedisValue[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.evalsha
- Defined in utils/RedisCommander.ts:3194
evalsha(
    ...args: [
        sha1: string
        | Buffer,
        numkeys: string | number,
        ...args: RedisValue[],
    ],
): Promise<unknown>
Parameters
- ...args: [sha1: string | Buffer, numkeys: string | number, ...args: RedisValue[]]
Returns Promise<unknown>
Inherited from Commander.evalsha
- Defined in utils/RedisCommander.ts:3202

evalsha_ro

evalsha_ro(
    sha1: string | Buffer,
    numkeys: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Executes a read-only server-side Lua script by SHA1 digest.
- group: scripting
- complexity: Depends on the script that is executed.
- since: 7.0.0
Parameters
- sha1: string | Buffer
- numkeys: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.evalsha_ro
- Defined in utils/RedisCommander.ts:3216
evalsha_ro(
    ...args: [
        sha1: string
        | Buffer,
        numkeys: string | number,
        ...args: (string | number | Buffer)[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      sha1: string
      | Buffer,
      numkeys: string | number,
      ...args: (string | number | Buffer)[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.evalsha_ro
- Defined in utils/RedisCommander.ts:3221
evalsha_ro(
    ...args: [
        sha1: string
        | Buffer,
        numkeys: string | number,
        ...args: (string | number | Buffer)[],
    ],
): Promise<unknown>
Parameters
- ...args: [
      sha1: string
      | Buffer,
      numkeys: string | number,
      ...args: (string | number | Buffer)[],
  ]
Returns Promise<unknown>
Inherited from Commander.evalsha_ro
- Defined in utils/RedisCommander.ts:3229
evalsha_ro(
    ...args: [
        sha1: string
        | Buffer,
        numkeys: string | number,
        ...keys: RedisKey[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      sha1: string
      | Buffer,
      numkeys: string | number,
      ...keys: RedisKey[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.evalsha_ro
- Defined in utils/RedisCommander.ts:3236
evalsha_ro(
    ...args: [
        sha1: string
        | Buffer,
        numkeys: string | number,
        keys: RedisKey[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      sha1: string
      | Buffer,
      numkeys: string | number,
      keys: RedisKey[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.evalsha_ro
- Defined in utils/RedisCommander.ts:3244
evalsha_ro(
    ...args: [
        sha1: string
        | Buffer,
        numkeys: string | number,
        ...keys: RedisKey[],
    ],
): Promise<unknown>
Parameters
- ...args: [sha1: string | Buffer, numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<unknown>
Inherited from Commander.evalsha_ro
- Defined in utils/RedisCommander.ts:3252
evalsha_ro(
    ...args: [
        sha1: string
        | Buffer,
        numkeys: string | number,
        keys: RedisKey[],
    ],
): Promise<unknown>
Parameters
- ...args: [sha1: string | Buffer, numkeys: string | number, keys: RedisKey[]]
Returns Promise<unknown>
Inherited from Commander.evalsha_ro
- Defined in utils/RedisCommander.ts:3259
evalsha_ro(
    ...args: [
        sha1: string
        | Buffer,
        numkeys: string | number,
        ...args: RedisValue[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      sha1: string
      | Buffer,
      numkeys: string | number,
      ...args: RedisValue[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.evalsha_ro
- Defined in utils/RedisCommander.ts:3262
evalsha_ro(
    ...args: [
        sha1: string
        | Buffer,
        numkeys: string | number,
        ...args: RedisValue[],
    ],
): Promise<unknown>
Parameters
- ...args: [sha1: string | Buffer, numkeys: string | number, ...args: RedisValue[]]
Returns Promise<unknown>
Inherited from Commander.evalsha_ro
- Defined in utils/RedisCommander.ts:3270

exec

exec(
callback?: Callback<[error: Error, result: unknown][]>,
): Promise<[error: Error, result: unknown][]>
Executes all commands in a transaction.
- group: transactions
- complexity: Depends on commands in the transaction
- since: 1.2.0
Parameters
- Optionalcallback: Callback<[error: Error, result: unknown][]>
Returns Promise<[error: Error, result: unknown][]>
Inherited from Commander.exec
- Defined in utils/RedisCommander.ts:3284

exists

exists(
...args: [...keys: RedisKey[], callback: Callback<number>],
): Promise<number>
Determines whether one or more keys exist.
- group: generic
- complexity: O(N) where N is the number of keys to check.
- since: 1.0.0
Parameters
- ...args: [...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Inherited from Commander.exists
- Defined in utils/RedisCommander.ts:3294
exists(...args: [keys: RedisKey[], callback: Callback<number>]): Promise<number>
Parameters
- ...args: [keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Inherited from Commander.exists
- Defined in utils/RedisCommander.ts:3297
exists(...args: RedisKey[]): Promise<number>
Parameters
- ...args: RedisKey[]
Returns Promise<number>
Inherited from Commander.exists
- Defined in utils/RedisCommander.ts:3300
exists(...args: [keys: RedisKey[]]): Promise<number>
Parameters
- ...args: [keys: RedisKey[]]
Returns Promise<number>
Inherited from Commander.exists
- Defined in utils/RedisCommander.ts:3301

expire

expire(
    key: RedisKey,
    seconds: string | number,
    callback?: Callback<number>,
): Promise<number>
Sets the expiration time of a key in seconds.
- group: generic
- complexity: O(1)
- since: 1.0.0
Parameters
- key: RedisKey
- seconds: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.expire
- Defined in utils/RedisCommander.ts:3309
expire(
    key: RedisKey,
    seconds: string | number,
    nx: "NX",
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- seconds: string | number
- nx: "NX"
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.expire
- Defined in utils/RedisCommander.ts:3314
expire(
    key: RedisKey,
    seconds: string | number,
    xx: "XX",
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- seconds: string | number
- xx: "XX"
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.expire
- Defined in utils/RedisCommander.ts:3320
expire(
    key: RedisKey,
    seconds: string | number,
    gt: "GT",
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- seconds: string | number
- gt: "GT"
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.expire
- Defined in utils/RedisCommander.ts:3326
expire(
    key: RedisKey,
    seconds: string | number,
    lt: "LT",
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- seconds: string | number
- lt: "LT"
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.expire
- Defined in utils/RedisCommander.ts:3332

expireat

expireat(
    key: RedisKey,
    unixTimeSeconds: string | number,
    callback?: Callback<number>,
): Promise<number>
Sets the expiration time of a key to a Unix timestamp.
- group: generic
- complexity: O(1)
- since: 1.2.0
Parameters
- key: RedisKey
- unixTimeSeconds: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.expireat
- Defined in utils/RedisCommander.ts:3345
expireat(
    key: RedisKey,
    unixTimeSeconds: string | number,
    nx: "NX",
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- unixTimeSeconds: string | number
- nx: "NX"
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.expireat
- Defined in utils/RedisCommander.ts:3350
expireat(
    key: RedisKey,
    unixTimeSeconds: string | number,
    xx: "XX",
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- unixTimeSeconds: string | number
- xx: "XX"
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.expireat
- Defined in utils/RedisCommander.ts:3356
expireat(
    key: RedisKey,
    unixTimeSeconds: string | number,
    gt: "GT",
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- unixTimeSeconds: string | number
- gt: "GT"
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.expireat
- Defined in utils/RedisCommander.ts:3362
expireat(
    key: RedisKey,
    unixTimeSeconds: string | number,
    lt: "LT",
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- unixTimeSeconds: string | number
- lt: "LT"
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.expireat
- Defined in utils/RedisCommander.ts:3368

expiretime

expiretime(key: RedisKey, callback?: Callback<number>): Promise<number>
Returns the expiration time of a key as a Unix timestamp.
- group: generic
- complexity: O(1)
- since: 7.0.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.expiretime
- Defined in utils/RedisCommander.ts:3381

failover

failover(callback?: Callback<"OK">): Promise<"OK">
Starts a coordinated failover from a server to one of its replicas.
- group: server
- complexity: O(1)
- since: 6.2.0
Parameters
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.failover
- Defined in utils/RedisCommander.ts:3392
failover(
    millisecondsToken: "TIMEOUT",
    milliseconds: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- millisecondsToken: "TIMEOUT"
- milliseconds: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.failover
- Defined in utils/RedisCommander.ts:3393
failover(abort: "ABORT", callback?: Callback<"OK">): Promise<"OK">
Parameters
- abort: "ABORT"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.failover
- Defined in utils/RedisCommander.ts:3398
failover(
    abort: "ABORT",
    millisecondsToken: "TIMEOUT",
    milliseconds: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- abort: "ABORT"
- millisecondsToken: "TIMEOUT"
- milliseconds: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.failover
- Defined in utils/RedisCommander.ts:3399
failover(
    targetToken: "TO",
    host: string | Buffer,
    port: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- targetToken: "TO"
- host: string | Buffer
- port: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.failover
- Defined in utils/RedisCommander.ts:3405
failover(
    targetToken: "TO",
    host: string | Buffer,
    port: string | number,
    millisecondsToken: "TIMEOUT",
    milliseconds: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- targetToken: "TO"
- host: string | Buffer
- port: string | number
- millisecondsToken: "TIMEOUT"
- milliseconds: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.failover
- Defined in utils/RedisCommander.ts:3411
failover(
    targetToken: "TO",
    host: string | Buffer,
    port: string | number,
    abort: "ABORT",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- targetToken: "TO"
- host: string | Buffer
- port: string | number
- abort: "ABORT"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.failover
- Defined in utils/RedisCommander.ts:3419
failover(
    targetToken: "TO",
    host: string | Buffer,
    port: string | number,
    abort: "ABORT",
    millisecondsToken: "TIMEOUT",
    milliseconds: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- targetToken: "TO"
- host: string | Buffer
- port: string | number
- abort: "ABORT"
- millisecondsToken: "TIMEOUT"
- milliseconds: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.failover
- Defined in utils/RedisCommander.ts:3426
failover(
    targetToken: "TO",
    host: string | Buffer,
    port: string | number,
    force: "FORCE",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- targetToken: "TO"
- host: string | Buffer
- port: string | number
- force: "FORCE"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.failover
- Defined in utils/RedisCommander.ts:3435
failover(
    targetToken: "TO",
    host: string | Buffer,
    port: string | number,
    force: "FORCE",
    millisecondsToken: "TIMEOUT",
    milliseconds: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- targetToken: "TO"
- host: string | Buffer
- port: string | number
- force: "FORCE"
- millisecondsToken: "TIMEOUT"
- milliseconds: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.failover
- Defined in utils/RedisCommander.ts:3442
failover(
    targetToken: "TO",
    host: string | Buffer,
    port: string | number,
    force: "FORCE",
    abort: "ABORT",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- targetToken: "TO"
- host: string | Buffer
- port: string | number
- force: "FORCE"
- abort: "ABORT"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.failover
- Defined in utils/RedisCommander.ts:3451
failover(
    targetToken: "TO",
    host: string | Buffer,
    port: string | number,
    force: "FORCE",
    abort: "ABORT",
    millisecondsToken: "TIMEOUT",
    milliseconds: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- targetToken: "TO"
- host: string | Buffer
- port: string | number
- force: "FORCE"
- abort: "ABORT"
- millisecondsToken: "TIMEOUT"
- milliseconds: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.failover
- Defined in utils/RedisCommander.ts:3459

fcall

fcall(
    fun: string | Buffer,
    numkeys: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Invokes a function.
- group: scripting
- complexity: Depends on the function that is executed.
- since: 7.0.0
Parameters
- fun: string | Buffer
- numkeys: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.fcall
- Defined in utils/RedisCommander.ts:3476
fcall(
    ...args: [
        fun: string
        | Buffer,
        numkeys: string | number,
        ...args: (string | number | Buffer)[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      fun: string
      | Buffer,
      numkeys: string | number,
      ...args: (string | number | Buffer)[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.fcall
- Defined in utils/RedisCommander.ts:3481
fcall(
    ...args: [
        fun: string
        | Buffer,
        numkeys: string | number,
        ...args: (string | number | Buffer)[],
    ],
): Promise<unknown>
Parameters
- ...args: [
      fun: string
      | Buffer,
      numkeys: string | number,
      ...args: (string | number | Buffer)[],
  ]
Returns Promise<unknown>
Inherited from Commander.fcall
- Defined in utils/RedisCommander.ts:3489
fcall(
    ...args: [
        fun: string
        | Buffer,
        numkeys: string | number,
        ...keys: RedisKey[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      fun: string
      | Buffer,
      numkeys: string | number,
      ...keys: RedisKey[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.fcall
- Defined in utils/RedisCommander.ts:3496
fcall(
    ...args: [
        fun: string
        | Buffer,
        numkeys: string | number,
        keys: RedisKey[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      fun: string
      | Buffer,
      numkeys: string | number,
      keys: RedisKey[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.fcall
- Defined in utils/RedisCommander.ts:3504
fcall(
    ...args: [
        fun: string
        | Buffer,
        numkeys: string | number,
        ...keys: RedisKey[],
    ],
): Promise<unknown>
Parameters
- ...args: [fun: string | Buffer, numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<unknown>
Inherited from Commander.fcall
- Defined in utils/RedisCommander.ts:3512
fcall(
    ...args: [
        fun: string
        | Buffer,
        numkeys: string | number,
        keys: RedisKey[],
    ],
): Promise<unknown>
Parameters
- ...args: [fun: string | Buffer, numkeys: string | number, keys: RedisKey[]]
Returns Promise<unknown>
Inherited from Commander.fcall
- Defined in utils/RedisCommander.ts:3519
fcall(
    ...args: [
        fun: string
        | Buffer,
        numkeys: string | number,
        ...args: RedisValue[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      fun: string
      | Buffer,
      numkeys: string | number,
      ...args: RedisValue[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.fcall
- Defined in utils/RedisCommander.ts:3522
fcall(
    ...args: [
        fun: string
        | Buffer,
        numkeys: string | number,
        ...args: RedisValue[],
    ],
): Promise<unknown>
Parameters
- ...args: [fun: string | Buffer, numkeys: string | number, ...args: RedisValue[]]
Returns Promise<unknown>
Inherited from Commander.fcall
- Defined in utils/RedisCommander.ts:3530

fcall_ro

fcall_ro(
    fun: string | Buffer,
    numkeys: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Invokes a read-only function.
- group: scripting
- complexity: Depends on the function that is executed.
- since: 7.0.0
Parameters
- fun: string | Buffer
- numkeys: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.fcall_ro
- Defined in utils/RedisCommander.ts:3544
fcall_ro(
    ...args: [
        fun: string
        | Buffer,
        numkeys: string | number,
        ...args: (string | number | Buffer)[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      fun: string
      | Buffer,
      numkeys: string | number,
      ...args: (string | number | Buffer)[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.fcall_ro
- Defined in utils/RedisCommander.ts:3549
fcall_ro(
    ...args: [
        fun: string
        | Buffer,
        numkeys: string | number,
        ...args: (string | number | Buffer)[],
    ],
): Promise<unknown>
Parameters
- ...args: [
      fun: string
      | Buffer,
      numkeys: string | number,
      ...args: (string | number | Buffer)[],
  ]
Returns Promise<unknown>
Inherited from Commander.fcall_ro
- Defined in utils/RedisCommander.ts:3557
fcall_ro(
    ...args: [
        fun: string
        | Buffer,
        numkeys: string | number,
        ...keys: RedisKey[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      fun: string
      | Buffer,
      numkeys: string | number,
      ...keys: RedisKey[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.fcall_ro
- Defined in utils/RedisCommander.ts:3564
fcall_ro(
    ...args: [
        fun: string
        | Buffer,
        numkeys: string | number,
        keys: RedisKey[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      fun: string
      | Buffer,
      numkeys: string | number,
      keys: RedisKey[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.fcall_ro
- Defined in utils/RedisCommander.ts:3572
fcall_ro(
    ...args: [
        fun: string
        | Buffer,
        numkeys: string | number,
        ...keys: RedisKey[],
    ],
): Promise<unknown>
Parameters
- ...args: [fun: string | Buffer, numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<unknown>
Inherited from Commander.fcall_ro
- Defined in utils/RedisCommander.ts:3580
fcall_ro(
    ...args: [
        fun: string
        | Buffer,
        numkeys: string | number,
        keys: RedisKey[],
    ],
): Promise<unknown>
Parameters
- ...args: [fun: string | Buffer, numkeys: string | number, keys: RedisKey[]]
Returns Promise<unknown>
Inherited from Commander.fcall_ro
- Defined in utils/RedisCommander.ts:3587
fcall_ro(
    ...args: [
        fun: string
        | Buffer,
        numkeys: string | number,
        ...args: RedisValue[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      fun: string
      | Buffer,
      numkeys: string | number,
      ...args: RedisValue[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.fcall_ro
- Defined in utils/RedisCommander.ts:3590
fcall_ro(
    ...args: [
        fun: string
        | Buffer,
        numkeys: string | number,
        ...args: RedisValue[],
    ],
): Promise<unknown>
Parameters
- ...args: [fun: string | Buffer, numkeys: string | number, ...args: RedisValue[]]
Returns Promise<unknown>
Inherited from Commander.fcall_ro
- Defined in utils/RedisCommander.ts:3598

flushall

flushall(callback?: Callback<"OK">): Promise<"OK">
Removes all keys from all databases.
- group: server
- complexity: O(N) where N is the total number of keys in all databases
- since: 1.0.0
Parameters
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.flushall
- Defined in utils/RedisCommander.ts:3612
flushall(async: "ASYNC", callback?: Callback<"OK">): Promise<"OK">
Parameters
- async: "ASYNC"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.flushall
- Defined in utils/RedisCommander.ts:3613
flushall(sync: "SYNC", callback?: Callback<"OK">): Promise<"OK">
Parameters
- sync: "SYNC"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.flushall
- Defined in utils/RedisCommander.ts:3614

flushdb

flushdb(callback?: Callback<"OK">): Promise<"OK">
Remove all keys from the current database.
- group: server
- complexity: O(N) where N is the number of keys in the selected database
- since: 1.0.0
Parameters
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.flushdb
- Defined in utils/RedisCommander.ts:3622
flushdb(async: "ASYNC", callback?: Callback<"OK">): Promise<"OK">
Parameters
- async: "ASYNC"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.flushdb
- Defined in utils/RedisCommander.ts:3623
flushdb(sync: "SYNC", callback?: Callback<"OK">): Promise<"OK">
Parameters
- sync: "SYNC"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.flushdb
- Defined in utils/RedisCommander.ts:3624

geoadd

geoadd(
    ...args: [
        key: RedisKey,
        ...data: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Adds one or more members to a geospatial index. The key is created if it doesn't exist.
- group: geo
- complexity: O(log(N)) for each item added, where N is the number of elements in the sorted set.
- since: 3.2.0
Parameters
- ...args: [
      key: RedisKey,
      ...data: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.geoadd
- Defined in utils/RedisCommander.ts:3632
geoadd(
...args: [key: RedisKey, ...data: (string | number | Buffer)[]],
): Promise<number>
Parameters
- ...args: [key: RedisKey, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.geoadd
- Defined in utils/RedisCommander.ts:3639
geoadd(
    ...args: [
        key: RedisKey,
        ch: "CH",
        ...data: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      key: RedisKey,
      ch: "CH",
      ...data: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.geoadd
- Defined in utils/RedisCommander.ts:3642
geoadd(
    ...args: [
        key: RedisKey,
        ch: "CH",
        ...data: (string | number | Buffer)[],
    ],
): Promise<number>
Parameters
- ...args: [key: RedisKey, ch: "CH", ...data: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.geoadd
- Defined in utils/RedisCommander.ts:3650
geoadd(
    ...args: [
        key: RedisKey,
        nx: "NX",
        ...data: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      key: RedisKey,
      nx: "NX",
      ...data: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.geoadd
- Defined in utils/RedisCommander.ts:3653
geoadd(
    ...args: [
        key: RedisKey,
        nx: "NX",
        ...data: (string | number | Buffer)[],
    ],
): Promise<number>
Parameters
- ...args: [key: RedisKey, nx: "NX", ...data: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.geoadd
- Defined in utils/RedisCommander.ts:3661
geoadd(
    ...args: [
        key: RedisKey,
        nx: "NX",
        ch: "CH",
        ...data: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      key: RedisKey,
      nx: "NX",
      ch: "CH",
      ...data: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.geoadd
- Defined in utils/RedisCommander.ts:3664
geoadd(
    ...args: [
        key: RedisKey,
        nx: "NX",
        ch: "CH",
        ...data: (string | number | Buffer)[],
    ],
): Promise<number>
Parameters
- ...args: [key: RedisKey, nx: "NX", ch: "CH", ...data: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.geoadd
- Defined in utils/RedisCommander.ts:3673
geoadd(
    ...args: [
        key: RedisKey,
        xx: "XX",
        ...data: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      key: RedisKey,
      xx: "XX",
      ...data: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.geoadd
- Defined in utils/RedisCommander.ts:3681
geoadd(
    ...args: [
        key: RedisKey,
        xx: "XX",
        ...data: (string | number | Buffer)[],
    ],
): Promise<number>
Parameters
- ...args: [key: RedisKey, xx: "XX", ...data: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.geoadd
- Defined in utils/RedisCommander.ts:3689
geoadd(
    ...args: [
        key: RedisKey,
        xx: "XX",
        ch: "CH",
        ...data: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      key: RedisKey,
      xx: "XX",
      ch: "CH",
      ...data: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.geoadd
- Defined in utils/RedisCommander.ts:3692
geoadd(
    ...args: [
        key: RedisKey,
        xx: "XX",
        ch: "CH",
        ...data: (string | number | Buffer)[],
    ],
): Promise<number>
Parameters
- ...args: [key: RedisKey, xx: "XX", ch: "CH", ...data: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.geoadd
- Defined in utils/RedisCommander.ts:3701

geodist

geodist(
    key: RedisKey,
    member1: string | number | Buffer,
    member2: string | number | Buffer,
    callback?: Callback<string>,
): Promise<string>
Returns the distance between two members of a geospatial index.
- group: geo
- complexity: O(1)
- since: 3.2.0
Parameters
- key: RedisKey
- member1: string | number | Buffer
- member2: string | number | Buffer
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.geodist
- Defined in utils/RedisCommander.ts:3716
geodist(
    key: RedisKey,
    member1: string | number | Buffer,
    member2: string | number | Buffer,
    m: "M",
    callback?: Callback<string>,
): Promise<string>
Parameters
- key: RedisKey
- member1: string | number | Buffer
- member2: string | number | Buffer
- m: "M"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.geodist
- Defined in utils/RedisCommander.ts:3728
geodist(
    key: RedisKey,
    member1: string | number | Buffer,
    member2: string | number | Buffer,
    km: "KM",
    callback?: Callback<string>,
): Promise<string>
Parameters
- key: RedisKey
- member1: string | number | Buffer
- member2: string | number | Buffer
- km: "KM"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.geodist
- Defined in utils/RedisCommander.ts:3742
geodist(
    key: RedisKey,
    member1: string | number | Buffer,
    member2: string | number | Buffer,
    ft: "FT",
    callback?: Callback<string>,
): Promise<string>
Parameters
- key: RedisKey
- member1: string | number | Buffer
- member2: string | number | Buffer
- ft: "FT"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.geodist
- Defined in utils/RedisCommander.ts:3756
geodist(
    key: RedisKey,
    member1: string | number | Buffer,
    member2: string | number | Buffer,
    mi: "MI",
    callback?: Callback<string>,
): Promise<string>
Parameters
- key: RedisKey
- member1: string | number | Buffer
- member2: string | number | Buffer
- mi: "MI"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.geodist
- Defined in utils/RedisCommander.ts:3770

geodistBuffer

geodistBuffer(
    key: RedisKey,
    member1: string | number | Buffer,
    member2: string | number | Buffer,
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- member1: string | number | Buffer
- member2: string | number | Buffer
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.geodistBuffer
- Defined in utils/RedisCommander.ts:3722
geodistBuffer(
    key: RedisKey,
    member1: string | number | Buffer,
    member2: string | number | Buffer,
    m: "M",
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- member1: string | number | Buffer
- member2: string | number | Buffer
- m: "M"
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.geodistBuffer
- Defined in utils/RedisCommander.ts:3735
geodistBuffer(
    key: RedisKey,
    member1: string | number | Buffer,
    member2: string | number | Buffer,
    km: "KM",
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- member1: string | number | Buffer
- member2: string | number | Buffer
- km: "KM"
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.geodistBuffer
- Defined in utils/RedisCommander.ts:3749
geodistBuffer(
    key: RedisKey,
    member1: string | number | Buffer,
    member2: string | number | Buffer,
    ft: "FT",
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- member1: string | number | Buffer
- member2: string | number | Buffer
- ft: "FT"
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.geodistBuffer
- Defined in utils/RedisCommander.ts:3763
geodistBuffer(
    key: RedisKey,
    member1: string | number | Buffer,
    member2: string | number | Buffer,
    mi: "MI",
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- member1: string | number | Buffer
- member2: string | number | Buffer
- mi: "MI"
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.geodistBuffer
- Defined in utils/RedisCommander.ts:3777

geohash

geohash(key: RedisKey, callback?: Callback<string[]>): Promise<string[]>
Returns members from a geospatial index as geohash strings.
- group: geo
- complexity: O(1) for each member requested.
- since: 3.2.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.geohash
- Defined in utils/RedisCommander.ts:3791
geohash(
    ...args: [
        key: RedisKey,
        ...members: (string | number | Buffer)[],
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      key: RedisKey,
      ...members: (string | number | Buffer)[],
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.geohash
- Defined in utils/RedisCommander.ts:3799
geohash(
    ...args: [
        key: RedisKey,
        members: (string | number | Buffer)[],
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      key: RedisKey,
      members: (string | number | Buffer)[],
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.geohash
- Defined in utils/RedisCommander.ts:3813
geohash(
...args: [key: RedisKey, ...members: (string | number | Buffer)[]],
): Promise<string[]>
Parameters
- ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns Promise<string[]>
Inherited from Commander.geohash
- Defined in utils/RedisCommander.ts:3827
geohash(
...args: [key: RedisKey, members: (string | number | Buffer)[]],
): Promise<string[]>
Parameters
- ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns Promise<string[]>
Inherited from Commander.geohash
- Defined in utils/RedisCommander.ts:3833

geohashBuffer

geohashBuffer(key: RedisKey, callback?: Callback<Buffer[]>): Promise<Buffer[]>
Parameters
- key: RedisKey
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.geohashBuffer
- Defined in utils/RedisCommander.ts:3795
geohashBuffer(
    ...args: [
        key: RedisKey,
        ...members: (string | number | Buffer)[],
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      key: RedisKey,
      ...members: (string | number | Buffer)[],
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.geohashBuffer
- Defined in utils/RedisCommander.ts:3806
geohashBuffer(
    ...args: [
        key: RedisKey,
        members: (string | number | Buffer)[],
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      key: RedisKey,
      members: (string | number | Buffer)[],
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.geohashBuffer
- Defined in utils/RedisCommander.ts:3820
geohashBuffer(
...args: [key: RedisKey, ...members: (string | number | Buffer)[]],
): Promise<Buffer[]>
Parameters
- ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns Promise<Buffer[]>
Inherited from Commander.geohashBuffer
- Defined in utils/RedisCommander.ts:3830
geohashBuffer(
...args: [key: RedisKey, members: (string | number | Buffer)[]],
): Promise<Buffer[]>
Parameters
- ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns Promise<Buffer[]>
Inherited from Commander.geohashBuffer
- Defined in utils/RedisCommander.ts:3836

geopos

geopos(
key: RedisKey,
callback?: Callback<[longitude: string, latitude: string][]>,
): Promise<[longitude: string, latitude: string][]>
Returns the longitude and latitude of members from a geospatial index.
- group: geo
- complexity: O(1) for each member requested.
- since: 3.2.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<[longitude: string, latitude: string][]>
Returns Promise<[longitude: string, latitude: string][]>
Inherited from Commander.geopos
- Defined in utils/RedisCommander.ts:3846
geopos(
    ...args: [
        key: RedisKey,
        ...members: (string | number | Buffer)[],
        callback: Callback<[longitude: string, latitude: string][]>,
    ],
): Promise<[longitude: string, latitude: string][]>
Parameters
- ...args: [
      key: RedisKey,
      ...members: (string | number | Buffer)[],
      callback: Callback<[longitude: string, latitude: string][]>,
  ]
Returns Promise<[longitude: string, latitude: string][]>
Inherited from Commander.geopos
- Defined in utils/RedisCommander.ts:3850
geopos(
    ...args: [
        key: RedisKey,
        members: (string | number | Buffer)[],
        callback: Callback<[longitude: string, latitude: string][]>,
    ],
): Promise<[longitude: string, latitude: string][]>
Parameters
- ...args: [
      key: RedisKey,
      members: (string | number | Buffer)[],
      callback: Callback<[longitude: string, latitude: string][]>,
  ]
Returns Promise<[longitude: string, latitude: string][]>
Inherited from Commander.geopos
- Defined in utils/RedisCommander.ts:3857
geopos(
...args: [key: RedisKey, ...members: (string | number | Buffer)[]],
): Promise<[longitude: string, latitude: string][]>
Parameters
- ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns Promise<[longitude: string, latitude: string][]>
Inherited from Commander.geopos
- Defined in utils/RedisCommander.ts:3864
geopos(
...args: [key: RedisKey, members: (string | number | Buffer)[]],
): Promise<[longitude: string, latitude: string][]>
Parameters
- ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns Promise<[longitude: string, latitude: string][]>
Inherited from Commander.geopos
- Defined in utils/RedisCommander.ts:3867

georadius

georadius(
    ...args: [
        key: RedisKey,
        longitude: string
        | number,
        latitude: string | number,
        radius: string | number,
        ...args: RedisValue[],
        callback: Callback<unknown[]>,
    ],
): Promise<unknown[]>
Queries a geospatial index for members within a distance from a coordinate, optionally stores the result.
- group: geo
- complexity: O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index.
- since: 3.2.0
Parameters
- ...args: [
      key: RedisKey,
      longitude: string
      | number,
      latitude: string | number,
      radius: string | number,
      ...args: RedisValue[],
      callback: Callback<unknown[]>,
  ]
Returns Promise<unknown[]>
Inherited from Commander.georadius
- Defined in utils/RedisCommander.ts:3877
georadius(
    ...args: [
        key: RedisKey,
        longitude: string
        | number,
        latitude: string | number,
        radius: string | number,
        ...args: RedisValue[],
    ],
): Promise<unknown[]>
Parameters
- ...args: [
      key: RedisKey,
      longitude: string
      | number,
      latitude: string | number,
      radius: string | number,
      ...args: RedisValue[],
  ]
Returns Promise<unknown[]>
Inherited from Commander.georadius
- Defined in utils/RedisCommander.ts:3887

georadius_ro

georadius_ro(
    ...args: [
        key: RedisKey,
        longitude: string
        | number,
        latitude: string | number,
        radius: string | number,
        ...args: RedisValue[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Returns members from a geospatial index that are within a distance from a coordinate.
- group: geo
- complexity: O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index.
- since: 3.2.10
Parameters
- ...args: [
      key: RedisKey,
      longitude: string
      | number,
      latitude: string | number,
      radius: string | number,
      ...args: RedisValue[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.georadius_ro
- Defined in utils/RedisCommander.ts:3903
georadius_ro(
    ...args: [
        key: RedisKey,
        longitude: string
        | number,
        latitude: string | number,
        radius: string | number,
        ...args: RedisValue[],
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      longitude: string
      | number,
      latitude: string | number,
      radius: string | number,
      ...args: RedisValue[],
  ]
Returns Promise<unknown>
Inherited from Commander.georadius_ro
- Defined in utils/RedisCommander.ts:3913

georadiusbymember

georadiusbymember(
    ...args: [
        key: RedisKey,
        member: string
        | number
        | Buffer,
        radius: string | number,
        ...args: RedisValue[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Queries a geospatial index for members within a distance from a member, optionally stores the result.
- group: geo
- complexity: O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index.
- since: 3.2.0
Parameters
- ...args: [
      key: RedisKey,
      member: string
      | number
      | Buffer,
      radius: string | number,
      ...args: RedisValue[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.georadiusbymember
- Defined in utils/RedisCommander.ts:3929
georadiusbymember(
    ...args: [
        key: RedisKey,
        member: string
        | number
        | Buffer,
        radius: string | number,
        ...args: RedisValue[],
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      member: string
      | number
      | Buffer,
      radius: string | number,
      ...args: RedisValue[],
  ]
Returns Promise<unknown>
Inherited from Commander.georadiusbymember
- Defined in utils/RedisCommander.ts:3938

georadiusbymember_ro

georadiusbymember_ro(
    ...args: [
        key: RedisKey,
        member: string
        | number
        | Buffer,
        radius: string | number,
        ...args: RedisValue[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Returns members from a geospatial index that are within a distance from a member.
- group: geo
- complexity: O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index.
- since: 3.2.10
Parameters
- ...args: [
      key: RedisKey,
      member: string
      | number
      | Buffer,
      radius: string | number,
      ...args: RedisValue[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.georadiusbymember_ro
- Defined in utils/RedisCommander.ts:3953
georadiusbymember_ro(
    ...args: [
        key: RedisKey,
        member: string
        | number
        | Buffer,
        radius: string | number,
        ...args: RedisValue[],
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      member: string
      | number
      | Buffer,
      radius: string | number,
      ...args: RedisValue[],
  ]
Returns Promise<unknown>
Inherited from Commander.georadiusbymember_ro
- Defined in utils/RedisCommander.ts:3962

geosearch

geosearch(
    ...args: [
        key: RedisKey,
        ...args: RedisValue[],
        callback: Callback<unknown[]>,
    ],
): Promise<unknown[]>
Queries a geospatial index for members inside an area of a box or a circle.
- group: geo
- complexity: O(N+log(M)) where N is the number of elements in the grid-aligned bounding box area around the shape provided as the filter and M is the number of items inside the shape
- since: 6.2.0
Parameters
- ...args: [key: RedisKey, ...args: RedisValue[], callback: Callback<unknown[]>]
Returns Promise<unknown[]>
Inherited from Commander.geosearch
- Defined in utils/RedisCommander.ts:3977
geosearch(...args: [key: RedisKey, ...args: RedisValue[]]): Promise<unknown[]>
Parameters
- ...args: [key: RedisKey, ...args: RedisValue[]]
Returns Promise<unknown[]>
Inherited from Commander.geosearch
- Defined in utils/RedisCommander.ts:3984

geosearchstore

geosearchstore(
    ...args: [
        destination: RedisKey,
        source: RedisKey,
        ...args: RedisValue[],
        callback: Callback<number>,
    ],
): Promise<number>
Queries a geospatial index for members inside an area of a box or a circle, optionally stores the result.
- group: geo
- complexity: O(N+log(M)) where N is the number of elements in the grid-aligned bounding box area around the shape provided as the filter and M is the number of items inside the shape
- since: 6.2.0
Parameters
- ...args: [
      destination: RedisKey,
      source: RedisKey,
      ...args: RedisValue[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.geosearchstore
- Defined in utils/RedisCommander.ts:3994
geosearchstore(
    ...args: [
        destination: RedisKey,
        source: RedisKey,
        ...args: RedisValue[],
    ],
): Promise<number>
Parameters
- ...args: [destination: RedisKey, source: RedisKey, ...args: RedisValue[]]
Returns Promise<number>
Inherited from Commander.geosearchstore
- Defined in utils/RedisCommander.ts:4002

get

get(key: RedisKey, callback?: Callback<string>): Promise<string>
Returns the string value of a key.
- group: string
- complexity: O(1)
- since: 1.0.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.get
- Defined in utils/RedisCommander.ts:4012

getbit

getbit(
    key: RedisKey,
    offset: string | number,
    callback?: Callback<number>,
): Promise<number>
Returns a bit value by offset.
- group: bitmap
- complexity: O(1)
- since: 2.2.0
Parameters
- key: RedisKey
- offset: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.getbit
- Defined in utils/RedisCommander.ts:4027

getBuffer

getBuffer(key: RedisKey, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
- key: RedisKey
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.getBuffer
- Defined in utils/RedisCommander.ts:4016

getBuiltinCommands

getBuiltinCommands(): string[]
Return supported builtin commands

Returns string[]
Inherited from Commander.getBuiltinCommands
- Defined in utils/Commander.ts:33

getdel

getdel(key: RedisKey, callback?: Callback<string>): Promise<string>
Returns the string value of a key after deleting the key.
- group: string
- complexity: O(1)
- since: 6.2.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.getdel
- Defined in utils/RedisCommander.ts:4039

getdelBuffer

getdelBuffer(key: RedisKey, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
- key: RedisKey
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.getdelBuffer
- Defined in utils/RedisCommander.ts:4043

getex

getex(key: RedisKey, callback?: Callback<string>): Promise<string>
Returns the string value of a key after setting its expiration time.
- group: string
- complexity: O(1)
- since: 6.2.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.getex
- Defined in utils/RedisCommander.ts:4054
getex(
    key: RedisKey,
    secondsToken: "EX",
    seconds: string | number,
    callback?: Callback<string>,
): Promise<string>
Parameters
- key: RedisKey
- secondsToken: "EX"
- seconds: string | number
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.getex
- Defined in utils/RedisCommander.ts:4062
getex(
    key: RedisKey,
    millisecondsToken: "PX",
    milliseconds: string | number,
    callback?: Callback<string>,
): Promise<string>
Parameters
- key: RedisKey
- millisecondsToken: "PX"
- milliseconds: string | number
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.getex
- Defined in utils/RedisCommander.ts:4074
getex(
    key: RedisKey,
    unixTimeSecondsToken: "EXAT",
    unixTimeSeconds: string | number,
    callback?: Callback<string>,
): Promise<string>
Parameters
- key: RedisKey
- unixTimeSecondsToken: "EXAT"
- unixTimeSeconds: string | number
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.getex
- Defined in utils/RedisCommander.ts:4086
getex(
    key: RedisKey,
    unixTimeMillisecondsToken: "PXAT",
    unixTimeMilliseconds: string | number,
    callback?: Callback<string>,
): Promise<string>
Parameters
- key: RedisKey
- unixTimeMillisecondsToken: "PXAT"
- unixTimeMilliseconds: string | number
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.getex
- Defined in utils/RedisCommander.ts:4098
getex(
    key: RedisKey,
    persist: "PERSIST",
    callback?: Callback<string>,
): Promise<string>
Parameters
- key: RedisKey
- persist: "PERSIST"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.getex
- Defined in utils/RedisCommander.ts:4110

getexBuffer

getexBuffer(key: RedisKey, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
- key: RedisKey
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.getexBuffer
- Defined in utils/RedisCommander.ts:4058
getexBuffer(
    key: RedisKey,
    secondsToken: "EX",
    seconds: string | number,
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- secondsToken: "EX"
- seconds: string | number
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.getexBuffer
- Defined in utils/RedisCommander.ts:4068
getexBuffer(
    key: RedisKey,
    millisecondsToken: "PX",
    milliseconds: string | number,
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- millisecondsToken: "PX"
- milliseconds: string | number
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.getexBuffer
- Defined in utils/RedisCommander.ts:4080
getexBuffer(
    key: RedisKey,
    unixTimeSecondsToken: "EXAT",
    unixTimeSeconds: string | number,
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- unixTimeSecondsToken: "EXAT"
- unixTimeSeconds: string | number
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.getexBuffer
- Defined in utils/RedisCommander.ts:4092
getexBuffer(
    key: RedisKey,
    unixTimeMillisecondsToken: "PXAT",
    unixTimeMilliseconds: string | number,
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- unixTimeMillisecondsToken: "PXAT"
- unixTimeMilliseconds: string | number
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.getexBuffer
- Defined in utils/RedisCommander.ts:4104
getexBuffer(
    key: RedisKey,
    persist: "PERSIST",
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- persist: "PERSIST"
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.getexBuffer
- Defined in utils/RedisCommander.ts:4115

getrange

getrange(
    key: RedisKey,
    start: string | number,
    end: string | number,
    callback?: Callback<string>,
): Promise<string>
Returns a substring of the string stored at a key.
- group: string
- complexity: O(N) where N is the length of the returned string. The complexity is ultimately determined by the returned length, but because creating a substring from an existing string is very cheap, it can be considered O(1) for small strings.
- since: 2.4.0
Parameters
- key: RedisKey
- start: string | number
- end: string | number
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.getrange
- Defined in utils/RedisCommander.ts:4127

getrangeBuffer

getrangeBuffer(
    key: RedisKey,
    start: string | number,
    end: string | number,
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- start: string | number
- end: string | number
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.getrangeBuffer
- Defined in utils/RedisCommander.ts:4133

getset

getset(
    key: RedisKey,
    value: string | number | Buffer,
    callback?: Callback<string>,
): Promise<string>
Returns the previous string value of a key after setting it to a new value.
- group: string
- complexity: O(1)
- since: 1.0.0
Parameters
- key: RedisKey
- value: string | number | Buffer
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.getset
- Defined in utils/RedisCommander.ts:4146

getsetBuffer

getsetBuffer(
    key: RedisKey,
    value: string | number | Buffer,
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- value: string | number | Buffer
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.getsetBuffer
- Defined in utils/RedisCommander.ts:4151

hdel

hdel(
    ...args: [
        key: RedisKey,
        ...fields: (string | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Deletes one or more fields and their values from a hash. Deletes the hash if no fields remain.
- group: hash
- complexity: O(N) where N is the number of fields to be removed.
- since: 2.0.0
Parameters
- ...args: [key: RedisKey, ...fields: (string | Buffer)[], callback: Callback<number>]
Returns Promise<number>
Inherited from Commander.hdel
- Defined in utils/RedisCommander.ts:4163
hdel(...args: [key: RedisKey, ...fields: (string | Buffer)[]]): Promise<number>
Parameters
- ...args: [key: RedisKey, ...fields: (string | Buffer)[]]
Returns Promise<number>
Inherited from Commander.hdel
- Defined in utils/RedisCommander.ts:4170

hello

hello(callback?: Callback<unknown[]>): Promise<unknown[]>
Handshakes with the server.
- group: connection
- complexity: O(1)
- since: 6.0.0
Parameters
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.hello
- Defined in utils/RedisCommander.ts:4180
hello(
protover: string | number,
callback?: Callback<unknown[]>,
): Promise<unknown[]>
Parameters
- protover: string | number
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.hello
- Defined in utils/RedisCommander.ts:4181
hello(
    protover: string | number,
    clientnameToken: "SETNAME",
    clientname: string | Buffer,
    callback?: Callback<unknown[]>,
): Promise<unknown[]>
Parameters
- protover: string | number
- clientnameToken: "SETNAME"
- clientname: string | Buffer
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.hello
- Defined in utils/RedisCommander.ts:4185
hello(
    protover: string | number,
    authToken: "AUTH",
    username: string | Buffer,
    password: string | Buffer,
    callback?: Callback<unknown[]>,
): Promise<unknown[]>
Parameters
- protover: string | number
- authToken: "AUTH"
- username: string | Buffer
- password: string | Buffer
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.hello
- Defined in utils/RedisCommander.ts:4191
hello(
    protover: string | number,
    authToken: "AUTH",
    username: string | Buffer,
    password: string | Buffer,
    clientnameToken: "SETNAME",
    clientname: string | Buffer,
    callback?: Callback<unknown[]>,
): Promise<unknown[]>
Parameters
- protover: string | number
- authToken: "AUTH"
- username: string | Buffer
- password: string | Buffer
- clientnameToken: "SETNAME"
- clientname: string | Buffer
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.hello
- Defined in utils/RedisCommander.ts:4198

hexists

hexists(
    key: RedisKey,
    field: string | Buffer,
    callback?: Callback<number>,
): Promise<number>
Determines whether a field exists in a hash.
- group: hash
- complexity: O(1)
- since: 2.0.0
Parameters
- key: RedisKey
- field: string | Buffer
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.hexists
- Defined in utils/RedisCommander.ts:4214

hget

hget(
    key: RedisKey,
    field: string | Buffer,
    callback?: Callback<string>,
): Promise<string>
Returns the value of a field in a hash.
- group: hash
- complexity: O(1)
- since: 2.0.0
Parameters
- key: RedisKey
- field: string | Buffer
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.hget
- Defined in utils/RedisCommander.ts:4226

hgetall

hgetall(
key: RedisKey,
callback?: Callback<Record<string, string>>,
): Promise<Record<string, string>>
Returns all fields and values in a hash.
- group: hash
- complexity: O(N) where N is the size of the hash.
- since: 2.0.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<Record<string, string>>
Returns Promise<Record<string, string>>
Inherited from Commander.hgetall
- Defined in utils/RedisCommander.ts:4243

hgetallBuffer

hgetallBuffer(
key: RedisKey,
callback?: Callback<Record<string, Buffer>>,
): Promise<Record<string, Buffer>>
Parameters
- key: RedisKey
- Optionalcallback: Callback<Record<string, Buffer>>
Returns Promise<Record<string, Buffer>>
Inherited from Commander.hgetallBuffer
- Defined in utils/RedisCommander.ts:4247

hgetBuffer

hgetBuffer(
    key: RedisKey,
    field: string | Buffer,
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- field: string | Buffer
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.hgetBuffer
- Defined in utils/RedisCommander.ts:4231

hincrby

hincrby(
    key: RedisKey,
    field: string | Buffer,
    increment: string | number,
    callback?: Callback<number>,
): Promise<number>
Increments the integer value of a field in a hash by a number. Uses 0 as initial value if the field doesn't exist.
- group: hash
- complexity: O(1)
- since: 2.0.0
Parameters
- key: RedisKey
- field: string | Buffer
- increment: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.hincrby
- Defined in utils/RedisCommander.ts:4258

hincrbyfloat

hincrbyfloat(
    key: RedisKey,
    field: string | Buffer,
    increment: string | number,
    callback?: Callback<string>,
): Promise<string>
Increments the floating point value of a field by a number. Uses 0 as initial value if the field doesn't exist.
- group: hash
- complexity: O(1)
- since: 2.6.0
Parameters
- key: RedisKey
- field: string | Buffer
- increment: string | number
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.hincrbyfloat
- Defined in utils/RedisCommander.ts:4271

hincrbyfloatBuffer

hincrbyfloatBuffer(
    key: RedisKey,
    field: string | Buffer,
    increment: string | number,
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- field: string | Buffer
- increment: string | number
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.hincrbyfloatBuffer
- Defined in utils/RedisCommander.ts:4277

hkeys

hkeys(key: RedisKey, callback?: Callback<string[]>): Promise<string[]>
Returns all fields in a hash.
- group: hash
- complexity: O(N) where N is the size of the hash.
- since: 2.0.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.hkeys
- Defined in utils/RedisCommander.ts:4290

hkeysBuffer

hkeysBuffer(key: RedisKey, callback?: Callback<Buffer[]>): Promise<Buffer[]>
Parameters
- key: RedisKey
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.hkeysBuffer
- Defined in utils/RedisCommander.ts:4294

hlen

hlen(key: RedisKey, callback?: Callback<number>): Promise<number>
Returns the number of fields in a hash.
- group: hash
- complexity: O(1)
- since: 2.0.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.hlen
- Defined in utils/RedisCommander.ts:4305

hmget

hmget(
    ...args: [
        key: RedisKey,
        ...fields: (string | Buffer)[],
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Returns the values of all fields in a hash.
- group: hash
- complexity: O(N) where N is the number of fields being requested.
- since: 2.0.0
Parameters
- ...args: [key: RedisKey, ...fields: (string | Buffer)[], callback: Callback<string[]>]
Returns Promise<string[]>
Inherited from Commander.hmget
- Defined in utils/RedisCommander.ts:4313
hmget(
...args: [key: RedisKey, ...fields: (string | Buffer)[]],
): Promise<string[]>
Parameters
- ...args: [key: RedisKey, ...fields: (string | Buffer)[]]
Returns Promise<string[]>
Inherited from Commander.hmget
- Defined in utils/RedisCommander.ts:4327

hmgetBuffer

hmgetBuffer(
    ...args: [
        key: RedisKey,
        ...fields: (string | Buffer)[],
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [key: RedisKey, ...fields: (string | Buffer)[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Inherited from Commander.hmgetBuffer
- Defined in utils/RedisCommander.ts:4320
hmgetBuffer(
...args: [key: RedisKey, ...fields: (string | Buffer)[]],
): Promise<Buffer[]>
Parameters
- ...args: [key: RedisKey, ...fields: (string | Buffer)[]]
Returns Promise<Buffer[]>
Inherited from Commander.hmgetBuffer
- Defined in utils/RedisCommander.ts:4330

hmset

hmset(key: RedisKey, object: object, callback?: Callback<"OK">): Promise<"OK">
Sets the values of multiple fields.
- group: hash
- complexity: O(N) where N is the number of fields being set.
- since: 2.0.0
Parameters
- key: RedisKey
- object: object
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.hmset
- Defined in utils/RedisCommander.ts:4340
hmset(
    key: RedisKey,
    map: Map<string | number | Buffer, string | number | Buffer>,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- map: Map<string | number | Buffer, string | number | Buffer>
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.hmset
- Defined in utils/RedisCommander.ts:4345
hmset(
    ...args: [
        key: RedisKey,
        ...data: (string | number | Buffer)[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [key: RedisKey, ...data: (string | number | Buffer)[], callback: Callback<"OK">]
Returns Promise<"OK">
Inherited from Commander.hmset
- Defined in utils/RedisCommander.ts:4350
hmset(
...args: [key: RedisKey, ...data: (string | number | Buffer)[]],
): Promise<"OK">
Parameters
- ...args: [key: RedisKey, ...data: (string | number | Buffer)[]]
Returns Promise<"OK">
Inherited from Commander.hmset
- Defined in utils/RedisCommander.ts:4357

hrandfield

hrandfield(
key: RedisKey,
callback?: Callback<string | unknown[]>,
): Promise<string | unknown[]>
Returns one or more random fields from a hash.
- group: hash
- complexity: O(N) where N is the number of fields returned
- since: 6.2.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<string | unknown[]>
Returns Promise<string | unknown[]>
Inherited from Commander.hrandfield
- Defined in utils/RedisCommander.ts:4367
hrandfield(
    key: RedisKey,
    count: string | number,
    callback?: Callback<string | unknown[]>,
): Promise<string | unknown[]>
Parameters
- key: RedisKey
- count: string | number
- Optionalcallback: Callback<string | unknown[]>
Returns Promise<string | unknown[]>
Inherited from Commander.hrandfield
- Defined in utils/RedisCommander.ts:4375
hrandfield(
    key: RedisKey,
    count: string | number,
    withvalues: "WITHVALUES",
    callback?: Callback<string | unknown[]>,
): Promise<string | unknown[]>
Parameters
- key: RedisKey
- count: string | number
- withvalues: "WITHVALUES"
- Optionalcallback: Callback<string | unknown[]>
Returns Promise<string | unknown[]>
Inherited from Commander.hrandfield
- Defined in utils/RedisCommander.ts:4385

hrandfieldBuffer

hrandfieldBuffer(
key: RedisKey,
callback?: Callback<unknown[] | Buffer>,
): Promise<unknown[] | Buffer>
Parameters
- key: RedisKey
- Optionalcallback: Callback<unknown[] | Buffer>
Returns Promise<unknown[] | Buffer>
Inherited from Commander.hrandfieldBuffer
- Defined in utils/RedisCommander.ts:4371
hrandfieldBuffer(
    key: RedisKey,
    count: string | number,
    callback?: Callback<unknown[] | Buffer>,
): Promise<unknown[] | Buffer>
Parameters
- key: RedisKey
- count: string | number
- Optionalcallback: Callback<unknown[] | Buffer>
Returns Promise<unknown[] | Buffer>
Inherited from Commander.hrandfieldBuffer
- Defined in utils/RedisCommander.ts:4380
hrandfieldBuffer(
    key: RedisKey,
    count: string | number,
    withvalues: "WITHVALUES",
    callback?: Callback<unknown[] | Buffer>,
): Promise<unknown[] | Buffer>
Parameters
- key: RedisKey
- count: string | number
- withvalues: "WITHVALUES"
- Optionalcallback: Callback<unknown[] | Buffer>
Returns Promise<unknown[] | Buffer>
Inherited from Commander.hrandfieldBuffer
- Defined in utils/RedisCommander.ts:4391

hscan

hscan(
    key: RedisKey,
    cursor: string | number,
    callback?: Callback<[cursor: string, elements: string[]]>,
): Promise<[cursor: string, elements: string[]]>
Iterates over fields and values of a hash.
- group: hash
- complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection.
- since: 2.8.0
Parameters
- key: RedisKey
- cursor: string | number
- Optionalcallback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Inherited from Commander.hscan
- Defined in utils/RedisCommander.ts:4404
hscan(
    key: RedisKey,
    cursor: string | number,
    novalues: "NOVALUES",
    callback?: Callback<[cursor: string, elements: string[]]>,
): Promise<[cursor: string, elements: string[]]>
Parameters
- key: RedisKey
- cursor: string | number
- novalues: "NOVALUES"
- Optionalcallback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Inherited from Commander.hscan
- Defined in utils/RedisCommander.ts:4414
hscan(
    key: RedisKey,
    cursor: string | number,
    countToken: "COUNT",
    count: string | number,
    callback?: Callback<[cursor: string, elements: string[]]>,
): Promise<[cursor: string, elements: string[]]>
Parameters
- key: RedisKey
- cursor: string | number
- countToken: "COUNT"
- count: string | number
- Optionalcallback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Inherited from Commander.hscan
- Defined in utils/RedisCommander.ts:4426
hscan(
    key: RedisKey,
    cursor: string | number,
    countToken: "COUNT",
    count: string | number,
    novalues: "NOVALUES",
    callback?: Callback<[cursor: string, elements: string[]]>,
): Promise<[cursor: string, elements: string[]]>
Parameters
- key: RedisKey
- cursor: string | number
- countToken: "COUNT"
- count: string | number
- novalues: "NOVALUES"
- Optionalcallback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Inherited from Commander.hscan
- Defined in utils/RedisCommander.ts:4440
hscan(
    key: RedisKey,
    cursor: string | number,
    patternToken: "MATCH",
    pattern: string,
    callback?: Callback<[cursor: string, elements: string[]]>,
): Promise<[cursor: string, elements: string[]]>
Parameters
- key: RedisKey
- cursor: string | number
- patternToken: "MATCH"
- pattern: string
- Optionalcallback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Inherited from Commander.hscan
- Defined in utils/RedisCommander.ts:4456
hscan(
    key: RedisKey,
    cursor: string | number,
    patternToken: "MATCH",
    pattern: string,
    novalues: "NOVALUES",
    callback?: Callback<[cursor: string, elements: string[]]>,
): Promise<[cursor: string, elements: string[]]>
Parameters
- key: RedisKey
- cursor: string | number
- patternToken: "MATCH"
- pattern: string
- novalues: "NOVALUES"
- Optionalcallback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Inherited from Commander.hscan
- Defined in utils/RedisCommander.ts:4470
hscan(
    key: RedisKey,
    cursor: string | number,
    patternToken: "MATCH",
    pattern: string,
    countToken: "COUNT",
    count: string | number,
    callback?: Callback<[cursor: string, elements: string[]]>,
): Promise<[cursor: string, elements: string[]]>
Parameters
- key: RedisKey
- cursor: string | number
- patternToken: "MATCH"
- pattern: string
- countToken: "COUNT"
- count: string | number
- Optionalcallback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Inherited from Commander.hscan
- Defined in utils/RedisCommander.ts:4486
hscan(
    key: RedisKey,
    cursor: string | number,
    patternToken: "MATCH",
    pattern: string,
    countToken: "COUNT",
    count: string | number,
    novalues: "NOVALUES",
    callback?: Callback<[cursor: string, elements: string[]]>,
): Promise<[cursor: string, elements: string[]]>
Parameters
- key: RedisKey
- cursor: string | number
- patternToken: "MATCH"
- pattern: string
- countToken: "COUNT"
- count: string | number
- novalues: "NOVALUES"
- Optionalcallback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Inherited from Commander.hscan
- Defined in utils/RedisCommander.ts:4504

hscanBuffer

hscanBuffer(
    key: RedisKey,
    cursor: string | number,
    callback?: Callback<[cursor: Buffer, elements: Buffer[]]>,
): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
- key: RedisKey
- cursor: string | number
- Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Inherited from Commander.hscanBuffer
- Defined in utils/RedisCommander.ts:4409
hscanBuffer(
    key: RedisKey,
    cursor: string | number,
    novalues: "NOVALUES",
    callback?: Callback<[cursor: Buffer, elements: Buffer[]]>,
): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
- key: RedisKey
- cursor: string | number
- novalues: "NOVALUES"
- Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Inherited from Commander.hscanBuffer
- Defined in utils/RedisCommander.ts:4420
hscanBuffer(
    key: RedisKey,
    cursor: string | number,
    countToken: "COUNT",
    count: string | number,
    callback?: Callback<[cursor: Buffer, elements: Buffer[]]>,
): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
- key: RedisKey
- cursor: string | number
- countToken: "COUNT"
- count: string | number
- Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Inherited from Commander.hscanBuffer
- Defined in utils/RedisCommander.ts:4433
hscanBuffer(
    key: RedisKey,
    cursor: string | number,
    countToken: "COUNT",
    count: string | number,
    novalues: "NOVALUES",
    callback?: Callback<[cursor: Buffer, elements: Buffer[]]>,
): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
- key: RedisKey
- cursor: string | number
- countToken: "COUNT"
- count: string | number
- novalues: "NOVALUES"
- Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Inherited from Commander.hscanBuffer
- Defined in utils/RedisCommander.ts:4448
hscanBuffer(
    key: RedisKey,
    cursor: string | number,
    patternToken: "MATCH",
    pattern: string,
    callback?: Callback<[cursor: Buffer, elements: Buffer[]]>,
): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
- key: RedisKey
- cursor: string | number
- patternToken: "MATCH"
- pattern: string
- Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Inherited from Commander.hscanBuffer
- Defined in utils/RedisCommander.ts:4463
hscanBuffer(
    key: RedisKey,
    cursor: string | number,
    patternToken: "MATCH",
    pattern: string,
    novalues: "NOVALUES",
    callback?: Callback<[cursor: Buffer, elements: Buffer[]]>,
): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
- key: RedisKey
- cursor: string | number
- patternToken: "MATCH"
- pattern: string
- novalues: "NOVALUES"
- Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Inherited from Commander.hscanBuffer
- Defined in utils/RedisCommander.ts:4478
hscanBuffer(
    key: RedisKey,
    cursor: string | number,
    patternToken: "MATCH",
    pattern: string,
    countToken: "COUNT",
    count: string | number,
    callback?: Callback<[cursor: Buffer, elements: Buffer[]]>,
): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
- key: RedisKey
- cursor: string | number
- patternToken: "MATCH"
- pattern: string
- countToken: "COUNT"
- count: string | number
- Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Inherited from Commander.hscanBuffer
- Defined in utils/RedisCommander.ts:4495
hscanBuffer(
    key: RedisKey,
    cursor: string | number,
    patternToken: "MATCH",
    pattern: string,
    countToken: "COUNT",
    count: string | number,
    novalues: "NOVALUES",
    callback?: Callback<[cursor: Buffer, elements: Buffer[]]>,
): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
- key: RedisKey
- cursor: string | number
- patternToken: "MATCH"
- pattern: string
- countToken: "COUNT"
- count: string | number
- novalues: "NOVALUES"
- Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Inherited from Commander.hscanBuffer
- Defined in utils/RedisCommander.ts:4514

hscanBufferStream

hscanBufferStream(key: string, options?: ScanStreamOptions): ScanStream
Parameters
- key: string
- Optionaloptions: ScanStreamOptions
Returns ScanStream
- Defined in cluster/index.ts:629

hscanStream

hscanStream(key: string, options?: ScanStreamOptions): ScanStream
Parameters
- key: string
- Optionaloptions: ScanStreamOptions
Returns ScanStream
- Defined in cluster/index.ts:625

hset

hset(
    key: RedisKey,
    object: object,
    callback?: Callback<number>,
): Promise<number>
Creates or modifies the value of a field in a hash.
- group: hash
- complexity: O(1) for each field/value pair added, so O(N) to add N field/value pairs when the command is called with multiple field/value pairs.
- since: 2.0.0
Parameters
- key: RedisKey
- object: object
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.hset
- Defined in utils/RedisCommander.ts:4531
hset(
    key: RedisKey,
    map: Map<string | number | Buffer, string | number | Buffer>,
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- map: Map<string | number | Buffer, string | number | Buffer>
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.hset
- Defined in utils/RedisCommander.ts:4536
hset(
    ...args: [
        key: RedisKey,
        ...data: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      key: RedisKey,
      ...data: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.hset
- Defined in utils/RedisCommander.ts:4541
hset(
...args: [key: RedisKey, ...data: (string | number | Buffer)[]],
): Promise<number>
Parameters
- ...args: [key: RedisKey, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.hset
- Defined in utils/RedisCommander.ts:4548

hsetnx

hsetnx(
    key: RedisKey,
    field: string | Buffer,
    value: string | number | Buffer,
    callback?: Callback<number>,
): Promise<number>
Sets the value of a field in a hash only when the field doesn't exist.
- group: hash
- complexity: O(1)
- since: 2.0.0
Parameters
- key: RedisKey
- field: string | Buffer
- value: string | number | Buffer
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.hsetnx
- Defined in utils/RedisCommander.ts:4558

hstrlen

hstrlen(
    key: RedisKey,
    field: string | Buffer,
    callback?: Callback<number>,
): Promise<number>
Returns the length of the value of a field.
- group: hash
- complexity: O(1)
- since: 3.2.0
Parameters
- key: RedisKey
- field: string | Buffer
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.hstrlen
- Defined in utils/RedisCommander.ts:4571

hvals

hvals(key: RedisKey, callback?: Callback<string[]>): Promise<string[]>
Returns all values in a hash.
- group: hash
- complexity: O(N) where N is the size of the hash.
- since: 2.0.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.hvals
- Defined in utils/RedisCommander.ts:4583

hvalsBuffer

hvalsBuffer(key: RedisKey, callback?: Callback<Buffer[]>): Promise<Buffer[]>
Parameters
- key: RedisKey
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.hvalsBuffer
- Defined in utils/RedisCommander.ts:4587

incr

incr(key: RedisKey, callback?: Callback<number>): Promise<number>
Increments the integer value of a key by one. Uses 0 as initial value if the key doesn't exist.
- group: string
- complexity: O(1)
- since: 1.0.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.incr
- Defined in utils/RedisCommander.ts:4598

incrby

incrby(
    key: RedisKey,
    increment: string | number,
    callback?: Callback<number>,
): Promise<number>
Increments the integer value of a key by a number. Uses 0 as initial value if the key doesn't exist.
- group: string
- complexity: O(1)
- since: 1.0.0
Parameters
- key: RedisKey
- increment: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.incrby
- Defined in utils/RedisCommander.ts:4606

incrbyfloat

incrbyfloat(
    key: RedisKey,
    increment: string | number,
    callback?: Callback<string>,
): Promise<string>
Increment the floating point value of a key by a number. Uses 0 as initial value if the key doesn't exist.
- group: string
- complexity: O(1)
- since: 2.6.0
Parameters
- key: RedisKey
- increment: string | number
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.incrbyfloat
- Defined in utils/RedisCommander.ts:4618

info

info(callback?: Callback<string>): Promise<string>
Returns information and statistics about the server.
- group: server
- complexity: O(1)
- since: 1.0.0
Parameters
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.info
- Defined in utils/RedisCommander.ts:4630
info(
...args: [...sections: (string | Buffer)[], callback: Callback<string>],
): Promise<string>
Parameters
- ...args: [...sections: (string | Buffer)[], callback: Callback<string>]
Returns Promise<string>
Inherited from Commander.info
- Defined in utils/RedisCommander.ts:4631
info(...args: (string | Buffer)[]): Promise<string>
Parameters
- ...args: (string | Buffer)[]
Returns Promise<string>
Inherited from Commander.info
- Defined in utils/RedisCommander.ts:4634

keys

keys(pattern: string, callback?: Callback<string[]>): Promise<string[]>
Returns all key names that match a pattern.
- group: generic
- complexity: O(N) with N being the number of keys in the database, under the assumption that the key names in the database and the given pattern have limited length.
- since: 1.0.0
Parameters
- pattern: string
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.keys
- Defined in utils/RedisCommander.ts:4642

keysBuffer

keysBuffer(pattern: string, callback?: Callback<Buffer[]>): Promise<Buffer[]>
Parameters
- pattern: string
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.keysBuffer
- Defined in utils/RedisCommander.ts:4646

lastsave

lastsave(callback?: Callback<number>): Promise<number>
Returns the Unix timestamp of the last successful save to disk.
- group: server
- complexity: O(1)
- since: 1.0.0
Parameters
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.lastsave
- Defined in utils/RedisCommander.ts:4657

latency

latency(subcommand: "DOCTOR", callback?: Callback<string>): Promise<string>
Returns a human-readable latency analysis report.
- group: server
- complexity: O(1)
- since: 2.8.13
Parameters
- subcommand: "DOCTOR"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.latency
- Defined in utils/RedisCommander.ts:4665
latency(
    subcommand: "GRAPH",
    event: string | Buffer,
    callback?: Callback<string>,
): Promise<string>
Returns a latency graph for an event.
- group: server
- complexity: O(1)
- since: 2.8.13
Parameters
- subcommand: "GRAPH"
- event: string | Buffer
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.latency
- Defined in utils/RedisCommander.ts:4676
latency(subcommand: "HELP", callback?: Callback<unknown[]>): Promise<unknown[]>
Returns helpful text about the different subcommands.
- group: server
- complexity: O(1)
- since: 2.8.13
Parameters
- subcommand: "HELP"
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.latency
- Defined in utils/RedisCommander.ts:4688
latency(subcommand: "HISTOGRAM", callback?: Callback<unknown>): Promise<unknown>
Returns the cumulative distribution of latencies of a subset or all commands.
- group: server
- complexity: O(N) where N is the number of commands with latency information being retrieved.
- since: 7.0.0
Parameters
- subcommand: "HISTOGRAM"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.latency
- Defined in utils/RedisCommander.ts:4699
latency(
    ...args: [
        subcommand: "HISTOGRAM",
        ...commands: (string | Buffer)[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      subcommand: "HISTOGRAM",
      ...commands: (string | Buffer)[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.latency
- Defined in utils/RedisCommander.ts:4703
latency(
...args: [subcommand: "HISTOGRAM", ...commands: (string | Buffer)[]],
): Promise<unknown>
Parameters
- ...args: [subcommand: "HISTOGRAM", ...commands: (string | Buffer)[]]
Returns Promise<unknown>
Inherited from Commander.latency
- Defined in utils/RedisCommander.ts:4710
latency(
    subcommand: "HISTORY",
    event: string | Buffer,
    callback?: Callback<unknown[]>,
): Promise<unknown[]>
Returns timestamp-latency samples for an event.
- group: server
- complexity: O(1)
- since: 2.8.13
Parameters
- subcommand: "HISTORY"
- event: string | Buffer
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.latency
- Defined in utils/RedisCommander.ts:4720
latency(
subcommand: "LATEST",
callback?: Callback<unknown[]>,
): Promise<unknown[]>
Returns the latest latency samples for all events.
- group: server
- complexity: O(1)
- since: 2.8.13
Parameters
- subcommand: "LATEST"
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.latency
- Defined in utils/RedisCommander.ts:4732
latency(subcommand: "RESET", callback?: Callback<number>): Promise<number>
Resets the latency data for one or more events.
- group: server
- complexity: O(1)
- since: 2.8.13
Parameters
- subcommand: "RESET"
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.latency
- Defined in utils/RedisCommander.ts:4743
latency(
    ...args: [
        subcommand: "RESET",
        ...events: (string | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      subcommand: "RESET",
      ...events: (string | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.latency
- Defined in utils/RedisCommander.ts:4747
latency(
...args: [subcommand: "RESET", ...events: (string | Buffer)[]],
): Promise<number>
Parameters
- ...args: [subcommand: "RESET", ...events: (string | Buffer)[]]
Returns Promise<number>
Inherited from Commander.latency
- Defined in utils/RedisCommander.ts:4754

lcs

lcs(
    key1: RedisKey,
    key2: RedisKey,
    callback?: Callback<unknown>,
): Promise<unknown>
Finds the longest common substring.
- group: string
- complexity: O(N*M) where N and M are the lengths of s1 and s2, respectively
- since: 7.0.0
Parameters
- key1: RedisKey
- key2: RedisKey
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.lcs
- Defined in utils/RedisCommander.ts:4764
lcs(
    key1: RedisKey,
    key2: RedisKey,
    withmatchlen: "WITHMATCHLEN",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key1: RedisKey
- key2: RedisKey
- withmatchlen: "WITHMATCHLEN"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.lcs
- Defined in utils/RedisCommander.ts:4769
lcs(
    key1: RedisKey,
    key2: RedisKey,
    minMatchLenToken: "MINMATCHLEN",
    minMatchLen: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key1: RedisKey
- key2: RedisKey
- minMatchLenToken: "MINMATCHLEN"
- minMatchLen: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.lcs
- Defined in utils/RedisCommander.ts:4775
lcs(
    key1: RedisKey,
    key2: RedisKey,
    minMatchLenToken: "MINMATCHLEN",
    minMatchLen: string | number,
    withmatchlen: "WITHMATCHLEN",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key1: RedisKey
- key2: RedisKey
- minMatchLenToken: "MINMATCHLEN"
- minMatchLen: string | number
- withmatchlen: "WITHMATCHLEN"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.lcs
- Defined in utils/RedisCommander.ts:4782
lcs(
    key1: RedisKey,
    key2: RedisKey,
    idx: "IDX",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key1: RedisKey
- key2: RedisKey
- idx: "IDX"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.lcs
- Defined in utils/RedisCommander.ts:4790
lcs(
    key1: RedisKey,
    key2: RedisKey,
    idx: "IDX",
    withmatchlen: "WITHMATCHLEN",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key1: RedisKey
- key2: RedisKey
- idx: "IDX"
- withmatchlen: "WITHMATCHLEN"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.lcs
- Defined in utils/RedisCommander.ts:4796
lcs(
    key1: RedisKey,
    key2: RedisKey,
    idx: "IDX",
    minMatchLenToken: "MINMATCHLEN",
    minMatchLen: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key1: RedisKey
- key2: RedisKey
- idx: "IDX"
- minMatchLenToken: "MINMATCHLEN"
- minMatchLen: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.lcs
- Defined in utils/RedisCommander.ts:4803
lcs(
    key1: RedisKey,
    key2: RedisKey,
    idx: "IDX",
    minMatchLenToken: "MINMATCHLEN",
    minMatchLen: string | number,
    withmatchlen: "WITHMATCHLEN",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key1: RedisKey
- key2: RedisKey
- idx: "IDX"
- minMatchLenToken: "MINMATCHLEN"
- minMatchLen: string | number
- withmatchlen: "WITHMATCHLEN"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.lcs
- Defined in utils/RedisCommander.ts:4811
lcs(
    key1: RedisKey,
    key2: RedisKey,
    len: "LEN",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key1: RedisKey
- key2: RedisKey
- len: "LEN"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.lcs
- Defined in utils/RedisCommander.ts:4820
lcs(
    key1: RedisKey,
    key2: RedisKey,
    len: "LEN",
    withmatchlen: "WITHMATCHLEN",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key1: RedisKey
- key2: RedisKey
- len: "LEN"
- withmatchlen: "WITHMATCHLEN"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.lcs
- Defined in utils/RedisCommander.ts:4826
lcs(
    key1: RedisKey,
    key2: RedisKey,
    len: "LEN",
    minMatchLenToken: "MINMATCHLEN",
    minMatchLen: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key1: RedisKey
- key2: RedisKey
- len: "LEN"
- minMatchLenToken: "MINMATCHLEN"
- minMatchLen: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.lcs
- Defined in utils/RedisCommander.ts:4833
lcs(
    key1: RedisKey,
    key2: RedisKey,
    len: "LEN",
    minMatchLenToken: "MINMATCHLEN",
    minMatchLen: string | number,
    withmatchlen: "WITHMATCHLEN",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key1: RedisKey
- key2: RedisKey
- len: "LEN"
- minMatchLenToken: "MINMATCHLEN"
- minMatchLen: string | number
- withmatchlen: "WITHMATCHLEN"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.lcs
- Defined in utils/RedisCommander.ts:4841
lcs(
    key1: RedisKey,
    key2: RedisKey,
    len: "LEN",
    idx: "IDX",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key1: RedisKey
- key2: RedisKey
- len: "LEN"
- idx: "IDX"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.lcs
- Defined in utils/RedisCommander.ts:4850
lcs(
    key1: RedisKey,
    key2: RedisKey,
    len: "LEN",
    idx: "IDX",
    withmatchlen: "WITHMATCHLEN",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key1: RedisKey
- key2: RedisKey
- len: "LEN"
- idx: "IDX"
- withmatchlen: "WITHMATCHLEN"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.lcs
- Defined in utils/RedisCommander.ts:4857
lcs(
    key1: RedisKey,
    key2: RedisKey,
    len: "LEN",
    idx: "IDX",
    minMatchLenToken: "MINMATCHLEN",
    minMatchLen: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key1: RedisKey
- key2: RedisKey
- len: "LEN"
- idx: "IDX"
- minMatchLenToken: "MINMATCHLEN"
- minMatchLen: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.lcs
- Defined in utils/RedisCommander.ts:4865
lcs(
    key1: RedisKey,
    key2: RedisKey,
    len: "LEN",
    idx: "IDX",
    minMatchLenToken: "MINMATCHLEN",
    minMatchLen: string | number,
    withmatchlen: "WITHMATCHLEN",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key1: RedisKey
- key2: RedisKey
- len: "LEN"
- idx: "IDX"
- minMatchLenToken: "MINMATCHLEN"
- minMatchLen: string | number
- withmatchlen: "WITHMATCHLEN"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.lcs
- Defined in utils/RedisCommander.ts:4874

lindex

lindex(
    key: RedisKey,
    index: string | number,
    callback?: Callback<string>,
): Promise<string>
Returns an element from a list by its index.
- group: list
- complexity: O(N) where N is the number of elements to traverse to get to the element at index. This makes asking for the first or the last element of the list O(1).
- since: 1.0.0
Parameters
- key: RedisKey
- index: string | number
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.lindex
- Defined in utils/RedisCommander.ts:4891

lindexBuffer

lindexBuffer(
    key: RedisKey,
    index: string | number,
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- index: string | number
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.lindexBuffer
- Defined in utils/RedisCommander.ts:4896

linsert

linsert(
    key: RedisKey,
    before: "BEFORE",
    pivot: string | number | Buffer,
    element: string | number | Buffer,
    callback?: Callback<number>,
): Promise<number>
Inserts an element before or after another element in a list.
- group: list
- complexity: O(N) where N is the number of elements to traverse before seeing the value pivot. This means that inserting somewhere on the left end on the list (head) can be considered O(1) and inserting somewhere on the right end (tail) is O(N).
- since: 2.2.0
Parameters
- key: RedisKey
- before: "BEFORE"
- pivot: string | number | Buffer
- element: string | number | Buffer
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.linsert
- Defined in utils/RedisCommander.ts:4908
linsert(
    key: RedisKey,
    after: "AFTER",
    pivot: string | number | Buffer,
    element: string | number | Buffer,
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- after: "AFTER"
- pivot: string | number | Buffer
- element: string | number | Buffer
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.linsert
- Defined in utils/RedisCommander.ts:4915

llen

llen(key: RedisKey, callback?: Callback<number>): Promise<number>
Returns the length of a list.
- group: list
- complexity: O(1)
- since: 1.0.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.llen
- Defined in utils/RedisCommander.ts:4929

lmove

lmove(
    source: RedisKey,
    destination: RedisKey,
    left: "LEFT",
    left1: "LEFT",
    callback?: Callback<string>,
): Promise<string>
Returns an element after popping it from one list and pushing it to another. Deletes the list if the last element was moved.
- group: list
- complexity: O(1)
- since: 6.2.0
Parameters
- source: RedisKey
- destination: RedisKey
- left: "LEFT"
- left1: "LEFT"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.lmove
- Defined in utils/RedisCommander.ts:4937
lmove(
    source: RedisKey,
    destination: RedisKey,
    left: "LEFT",
    right: "RIGHT",
    callback?: Callback<string>,
): Promise<string>
Parameters
- source: RedisKey
- destination: RedisKey
- left: "LEFT"
- right: "RIGHT"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.lmove
- Defined in utils/RedisCommander.ts:4951
lmove(
    source: RedisKey,
    destination: RedisKey,
    right: "RIGHT",
    left: "LEFT",
    callback?: Callback<string>,
): Promise<string>
Parameters
- source: RedisKey
- destination: RedisKey
- right: "RIGHT"
- left: "LEFT"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.lmove
- Defined in utils/RedisCommander.ts:4965
lmove(
    source: RedisKey,
    destination: RedisKey,
    right: "RIGHT",
    right1: "RIGHT",
    callback?: Callback<string>,
): Promise<string>
Parameters
- source: RedisKey
- destination: RedisKey
- right: "RIGHT"
- right1: "RIGHT"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.lmove
- Defined in utils/RedisCommander.ts:4979

lmoveBuffer

lmoveBuffer(
    source: RedisKey,
    destination: RedisKey,
    left: "LEFT",
    left1: "LEFT",
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- source: RedisKey
- destination: RedisKey
- left: "LEFT"
- left1: "LEFT"
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.lmoveBuffer
- Defined in utils/RedisCommander.ts:4944
lmoveBuffer(
    source: RedisKey,
    destination: RedisKey,
    left: "LEFT",
    right: "RIGHT",
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- source: RedisKey
- destination: RedisKey
- left: "LEFT"
- right: "RIGHT"
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.lmoveBuffer
- Defined in utils/RedisCommander.ts:4958
lmoveBuffer(
    source: RedisKey,
    destination: RedisKey,
    right: "RIGHT",
    left: "LEFT",
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- source: RedisKey
- destination: RedisKey
- right: "RIGHT"
- left: "LEFT"
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.lmoveBuffer
- Defined in utils/RedisCommander.ts:4972
lmoveBuffer(
    source: RedisKey,
    destination: RedisKey,
    right: "RIGHT",
    right1: "RIGHT",
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- source: RedisKey
- destination: RedisKey
- right: "RIGHT"
- right1: "RIGHT"
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.lmoveBuffer
- Defined in utils/RedisCommander.ts:4986

lmpop

lmpop(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        left: "LEFT",
        callback: Callback<[key: string, members: string[]]>,
    ],
): Promise<[key: string, members: string[]]>
Returns multiple elements from a list after removing them. Deletes the list if the last element was popped.
- group: list
- complexity: O(N+M) where N is the number of provided keys and M is the number of elements returned.
- since: 7.0.0
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      left: "LEFT",
      callback: Callback<[key: string, members: string[]]>,
  ]
Returns Promise<[key: string, members: string[]]>
Inherited from Commander.lmpop
- Defined in utils/RedisCommander.ts:5000
lmpop(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        left: "LEFT",
        callback: Callback<[key: string, members: string[]]>,
    ],
): Promise<[key: string, members: string[]]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      left: "LEFT",
      callback: Callback<[key: string, members: string[]]>,
  ]
Returns Promise<[key: string, members: string[]]>
Inherited from Commander.lmpop
- Defined in utils/RedisCommander.ts:5016
lmpop(
...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT"],
): Promise<[key: string, members: string[]]>
Parameters
- ...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT"]
Returns Promise<[key: string, members: string[]]>
Inherited from Commander.lmpop
- Defined in utils/RedisCommander.ts:5032
lmpop(
...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT"],
): Promise<[key: string, members: string[]]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT"]
Returns Promise<[key: string, members: string[]]>
Inherited from Commander.lmpop
- Defined in utils/RedisCommander.ts:5038
lmpop(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        left: "LEFT",
        countToken: "COUNT",
        count: string | number,
        callback: Callback<[key: string, members: string[]]>,
    ],
): Promise<[key: string, members: string[]]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      left: "LEFT",
      countToken: "COUNT",
      count: string | number,
      callback: Callback<[key: string, members: string[]]>,
  ]
Returns Promise<[key: string, members: string[]]>
Inherited from Commander.lmpop
- Defined in utils/RedisCommander.ts:5044
lmpop(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        left: "LEFT",
        countToken: "COUNT",
        count: string | number,
        callback: Callback<[key: string, members: string[]]>,
    ],
): Promise<[key: string, members: string[]]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      left: "LEFT",
      countToken: "COUNT",
      count: string | number,
      callback: Callback<[key: string, members: string[]]>,
  ]
Returns Promise<[key: string, members: string[]]>
Inherited from Commander.lmpop
- Defined in utils/RedisCommander.ts:5064
lmpop(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        left: "LEFT",
        countToken: "COUNT",
        count: string | number,
    ],
): Promise<[key: string, members: string[]]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      left: "LEFT",
      countToken: "COUNT",
      count: string | number,
  ]
Returns Promise<[key: string, members: string[]]>
Inherited from Commander.lmpop
- Defined in utils/RedisCommander.ts:5084
lmpop(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        left: "LEFT",
        countToken: "COUNT",
        count: string | number,
    ],
): Promise<[key: string, members: string[]]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      left: "LEFT",
      countToken: "COUNT",
      count: string | number,
  ]
Returns Promise<[key: string, members: string[]]>
Inherited from Commander.lmpop
- Defined in utils/RedisCommander.ts:5102
lmpop(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        right: "RIGHT",
        callback: Callback<[key: string, members: string[]]>,
    ],
): Promise<[key: string, members: string[]]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      right: "RIGHT",
      callback: Callback<[key: string, members: string[]]>,
  ]
Returns Promise<[key: string, members: string[]]>
Inherited from Commander.lmpop
- Defined in utils/RedisCommander.ts:5120
lmpop(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        right: "RIGHT",
        callback: Callback<[key: string, members: string[]]>,
    ],
): Promise<[key: string, members: string[]]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      right: "RIGHT",
      callback: Callback<[key: string, members: string[]]>,
  ]
Returns Promise<[key: string, members: string[]]>
Inherited from Commander.lmpop
- Defined in utils/RedisCommander.ts:5136
lmpop(
...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT"],
): Promise<[key: string, members: string[]]>
Parameters
- ...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT"]
Returns Promise<[key: string, members: string[]]>
Inherited from Commander.lmpop
- Defined in utils/RedisCommander.ts:5152
lmpop(
...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT"],
): Promise<[key: string, members: string[]]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT"]
Returns Promise<[key: string, members: string[]]>
Inherited from Commander.lmpop
- Defined in utils/RedisCommander.ts:5158
lmpop(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        right: "RIGHT",
        countToken: "COUNT",
        count: string | number,
        callback: Callback<[key: string, members: string[]]>,
    ],
): Promise<[key: string, members: string[]]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      right: "RIGHT",
      countToken: "COUNT",
      count: string | number,
      callback: Callback<[key: string, members: string[]]>,
  ]
Returns Promise<[key: string, members: string[]]>
Inherited from Commander.lmpop
- Defined in utils/RedisCommander.ts:5164
lmpop(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        right: "RIGHT",
        countToken: "COUNT",
        count: string | number,
        callback: Callback<[key: string, members: string[]]>,
    ],
): Promise<[key: string, members: string[]]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      right: "RIGHT",
      countToken: "COUNT",
      count: string | number,
      callback: Callback<[key: string, members: string[]]>,
  ]
Returns Promise<[key: string, members: string[]]>
Inherited from Commander.lmpop
- Defined in utils/RedisCommander.ts:5184
lmpop(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        right: "RIGHT",
        countToken: "COUNT",
        count: string | number,
    ],
): Promise<[key: string, members: string[]]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      right: "RIGHT",
      countToken: "COUNT",
      count: string | number,
  ]
Returns Promise<[key: string, members: string[]]>
Inherited from Commander.lmpop
- Defined in utils/RedisCommander.ts:5204
lmpop(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        right: "RIGHT",
        countToken: "COUNT",
        count: string | number,
    ],
): Promise<[key: string, members: string[]]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      right: "RIGHT",
      countToken: "COUNT",
      count: string | number,
  ]
Returns Promise<[key: string, members: string[]]>
Inherited from Commander.lmpop
- Defined in utils/RedisCommander.ts:5222

lmpopBuffer

lmpopBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        left: "LEFT",
        callback: Callback<[key: Buffer, members: Buffer[]]>,
    ],
): Promise<[key: Buffer, members: Buffer[]]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      left: "LEFT",
      callback: Callback<[key: Buffer, members: Buffer[]]>,
  ]
Returns Promise<[key: Buffer, members: Buffer[]]>
Inherited from Commander.lmpopBuffer
- Defined in utils/RedisCommander.ts:5008
lmpopBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        left: "LEFT",
        callback: Callback<[key: Buffer, members: Buffer[]]>,
    ],
): Promise<[key: Buffer, members: Buffer[]]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      left: "LEFT",
      callback: Callback<[key: Buffer, members: Buffer[]]>,
  ]
Returns Promise<[key: Buffer, members: Buffer[]]>
Inherited from Commander.lmpopBuffer
- Defined in utils/RedisCommander.ts:5024
lmpopBuffer(
...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT"],
): Promise<[key: Buffer, members: Buffer[]]>
Parameters
- ...args: [numkeys: string | number, ...keys: RedisKey[], left: "LEFT"]
Returns Promise<[key: Buffer, members: Buffer[]]>
Inherited from Commander.lmpopBuffer
- Defined in utils/RedisCommander.ts:5035
lmpopBuffer(
...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT"],
): Promise<[key: Buffer, members: Buffer[]]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[], left: "LEFT"]
Returns Promise<[key: Buffer, members: Buffer[]]>
Inherited from Commander.lmpopBuffer
- Defined in utils/RedisCommander.ts:5041
lmpopBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        left: "LEFT",
        countToken: "COUNT",
        count: string | number,
        callback: Callback<[key: Buffer, members: Buffer[]]>,
    ],
): Promise<[key: Buffer, members: Buffer[]]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      left: "LEFT",
      countToken: "COUNT",
      count: string | number,
      callback: Callback<[key: Buffer, members: Buffer[]]>,
  ]
Returns Promise<[key: Buffer, members: Buffer[]]>
Inherited from Commander.lmpopBuffer
- Defined in utils/RedisCommander.ts:5054
lmpopBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        left: "LEFT",
        countToken: "COUNT",
        count: string | number,
        callback: Callback<[key: Buffer, members: Buffer[]]>,
    ],
): Promise<[key: Buffer, members: Buffer[]]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      left: "LEFT",
      countToken: "COUNT",
      count: string | number,
      callback: Callback<[key: Buffer, members: Buffer[]]>,
  ]
Returns Promise<[key: Buffer, members: Buffer[]]>
Inherited from Commander.lmpopBuffer
- Defined in utils/RedisCommander.ts:5074
lmpopBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        left: "LEFT",
        countToken: "COUNT",
        count: string | number,
    ],
): Promise<[key: Buffer, members: Buffer[]]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      left: "LEFT",
      countToken: "COUNT",
      count: string | number,
  ]
Returns Promise<[key: Buffer, members: Buffer[]]>
Inherited from Commander.lmpopBuffer
- Defined in utils/RedisCommander.ts:5093
lmpopBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        left: "LEFT",
        countToken: "COUNT",
        count: string | number,
    ],
): Promise<[key: Buffer, members: Buffer[]]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      left: "LEFT",
      countToken: "COUNT",
      count: string | number,
  ]
Returns Promise<[key: Buffer, members: Buffer[]]>
Inherited from Commander.lmpopBuffer
- Defined in utils/RedisCommander.ts:5111
lmpopBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        right: "RIGHT",
        callback: Callback<[key: Buffer, members: Buffer[]]>,
    ],
): Promise<[key: Buffer, members: Buffer[]]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      right: "RIGHT",
      callback: Callback<[key: Buffer, members: Buffer[]]>,
  ]
Returns Promise<[key: Buffer, members: Buffer[]]>
Inherited from Commander.lmpopBuffer
- Defined in utils/RedisCommander.ts:5128
lmpopBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        right: "RIGHT",
        callback: Callback<[key: Buffer, members: Buffer[]]>,
    ],
): Promise<[key: Buffer, members: Buffer[]]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      right: "RIGHT",
      callback: Callback<[key: Buffer, members: Buffer[]]>,
  ]
Returns Promise<[key: Buffer, members: Buffer[]]>
Inherited from Commander.lmpopBuffer
- Defined in utils/RedisCommander.ts:5144
lmpopBuffer(
...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT"],
): Promise<[key: Buffer, members: Buffer[]]>
Parameters
- ...args: [numkeys: string | number, ...keys: RedisKey[], right: "RIGHT"]
Returns Promise<[key: Buffer, members: Buffer[]]>
Inherited from Commander.lmpopBuffer
- Defined in utils/RedisCommander.ts:5155
lmpopBuffer(
...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT"],
): Promise<[key: Buffer, members: Buffer[]]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[], right: "RIGHT"]
Returns Promise<[key: Buffer, members: Buffer[]]>
Inherited from Commander.lmpopBuffer
- Defined in utils/RedisCommander.ts:5161
lmpopBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        right: "RIGHT",
        countToken: "COUNT",
        count: string | number,
        callback: Callback<[key: Buffer, members: Buffer[]]>,
    ],
): Promise<[key: Buffer, members: Buffer[]]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      right: "RIGHT",
      countToken: "COUNT",
      count: string | number,
      callback: Callback<[key: Buffer, members: Buffer[]]>,
  ]
Returns Promise<[key: Buffer, members: Buffer[]]>
Inherited from Commander.lmpopBuffer
- Defined in utils/RedisCommander.ts:5174
lmpopBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        right: "RIGHT",
        countToken: "COUNT",
        count: string | number,
        callback: Callback<[key: Buffer, members: Buffer[]]>,
    ],
): Promise<[key: Buffer, members: Buffer[]]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      right: "RIGHT",
      countToken: "COUNT",
      count: string | number,
      callback: Callback<[key: Buffer, members: Buffer[]]>,
  ]
Returns Promise<[key: Buffer, members: Buffer[]]>
Inherited from Commander.lmpopBuffer
- Defined in utils/RedisCommander.ts:5194
lmpopBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        right: "RIGHT",
        countToken: "COUNT",
        count: string | number,
    ],
): Promise<[key: Buffer, members: Buffer[]]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      right: "RIGHT",
      countToken: "COUNT",
      count: string | number,
  ]
Returns Promise<[key: Buffer, members: Buffer[]]>
Inherited from Commander.lmpopBuffer
- Defined in utils/RedisCommander.ts:5213
lmpopBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        right: "RIGHT",
        countToken: "COUNT",
        count: string | number,
    ],
): Promise<[key: Buffer, members: Buffer[]]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      right: "RIGHT",
      countToken: "COUNT",
      count: string | number,
  ]
Returns Promise<[key: Buffer, members: Buffer[]]>
Inherited from Commander.lmpopBuffer
- Defined in utils/RedisCommander.ts:5231

lolwut

lolwut(callback?: Callback<string>): Promise<string>
Displays computer art and the server version
- group: server
- complexity: undefined
- since: 5.0.0
Parameters
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.lolwut
- Defined in utils/RedisCommander.ts:5247
lolwut(
    versionToken: "VERSION",
    version: string | number,
    callback?: Callback<string>,
): Promise<string>
Parameters
- versionToken: "VERSION"
- version: string | number
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.lolwut
- Defined in utils/RedisCommander.ts:5248

lpop

lpop(key: RedisKey, callback?: Callback<string>): Promise<string>
Returns the first elements in a list after removing it. Deletes the list if the last element was popped.
- group: list
- complexity: O(N) where N is the number of elements returned
- since: 1.0.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.lpop
- Defined in utils/RedisCommander.ts:5260
lpop(
    key: RedisKey,
    count: string | number,
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- count: string | number
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.lpop
- Defined in utils/RedisCommander.ts:5268

lpopBuffer

lpopBuffer(key: RedisKey, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
- key: RedisKey
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.lpopBuffer
- Defined in utils/RedisCommander.ts:5264
lpopBuffer(
    key: RedisKey,
    count: string | number,
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- count: string | number
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.lpopBuffer
- Defined in utils/RedisCommander.ts:5273

lpos

lpos(
    key: RedisKey,
    element: string | number | Buffer,
    callback?: Callback<number>,
): Promise<number>
Returns the index of matching elements in a list.
- group: list
- complexity: O(N) where N is the number of elements in the list, for the average case. When searching for elements near the head or the tail of the list, or when the MAXLEN option is provided, the command may run in constant time.
- since: 6.0.6
Parameters
- key: RedisKey
- element: string | number | Buffer
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.lpos
- Defined in utils/RedisCommander.ts:5285
lpos(
    key: RedisKey,
    element: string | number | Buffer,
    lenToken: "MAXLEN",
    len: string | number,
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- element: string | number | Buffer
- lenToken: "MAXLEN"
- len: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.lpos
- Defined in utils/RedisCommander.ts:5290
lpos(
    key: RedisKey,
    element: string | number | Buffer,
    numMatchesToken: "COUNT",
    numMatches: string | number,
    callback?: Callback<number[]>,
): Promise<number[]>
Parameters
- key: RedisKey
- element: string | number | Buffer
- numMatchesToken: "COUNT"
- numMatches: string | number
- Optionalcallback: Callback<number[]>
Returns Promise<number[]>
Inherited from Commander.lpos
- Defined in utils/RedisCommander.ts:5297
lpos(
    key: RedisKey,
    element: string | number | Buffer,
    numMatchesToken: "COUNT",
    numMatches: string | number,
    lenToken: "MAXLEN",
    len: string | number,
    callback?: Callback<number[]>,
): Promise<number[]>
Parameters
- key: RedisKey
- element: string | number | Buffer
- numMatchesToken: "COUNT"
- numMatches: string | number
- lenToken: "MAXLEN"
- len: string | number
- Optionalcallback: Callback<number[]>
Returns Promise<number[]>
Inherited from Commander.lpos
- Defined in utils/RedisCommander.ts:5304
lpos(
    key: RedisKey,
    element: string | number | Buffer,
    rankToken: "RANK",
    rank: string | number,
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- element: string | number | Buffer
- rankToken: "RANK"
- rank: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.lpos
- Defined in utils/RedisCommander.ts:5313
lpos(
    key: RedisKey,
    element: string | number | Buffer,
    rankToken: "RANK",
    rank: string | number,
    lenToken: "MAXLEN",
    len: string | number,
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- element: string | number | Buffer
- rankToken: "RANK"
- rank: string | number
- lenToken: "MAXLEN"
- len: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.lpos
- Defined in utils/RedisCommander.ts:5320
lpos(
    key: RedisKey,
    element: string | number | Buffer,
    rankToken: "RANK",
    rank: string | number,
    numMatchesToken: "COUNT",
    numMatches: string | number,
    callback?: Callback<number[]>,
): Promise<number[]>
Parameters
- key: RedisKey
- element: string | number | Buffer
- rankToken: "RANK"
- rank: string | number
- numMatchesToken: "COUNT"
- numMatches: string | number
- Optionalcallback: Callback<number[]>
Returns Promise<number[]>
Inherited from Commander.lpos
- Defined in utils/RedisCommander.ts:5329
lpos(
    key: RedisKey,
    element: string | number | Buffer,
    rankToken: "RANK",
    rank: string | number,
    numMatchesToken: "COUNT",
    numMatches: string | number,
    lenToken: "MAXLEN",
    len: string | number,
    callback?: Callback<number[]>,
): Promise<number[]>
Parameters
- key: RedisKey
- element: string | number | Buffer
- rankToken: "RANK"
- rank: string | number
- numMatchesToken: "COUNT"
- numMatches: string | number
- lenToken: "MAXLEN"
- len: string | number
- Optionalcallback: Callback<number[]>
Returns Promise<number[]>
Inherited from Commander.lpos
- Defined in utils/RedisCommander.ts:5338

lpush

lpush(
    ...args: [
        key: RedisKey,
        ...elements: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Prepends one or more elements to a list. Creates the key if it doesn't exist.
- group: list
- complexity: O(1) for each element added, so O(N) to add N elements when the command is called with multiple arguments.
- since: 1.0.0
Parameters
- ...args: [
      key: RedisKey,
      ...elements: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.lpush
- Defined in utils/RedisCommander.ts:5356
lpush(
...args: [key: RedisKey, ...elements: (string | number | Buffer)[]],
): Promise<number>
Parameters
- ...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.lpush
- Defined in utils/RedisCommander.ts:5363

lpushx

lpushx(
    ...args: [
        key: RedisKey,
        ...elements: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Prepends one or more elements to a list only when the list exists.
- group: list
- complexity: O(1) for each element added, so O(N) to add N elements when the command is called with multiple arguments.
- since: 2.2.0
Parameters
- ...args: [
      key: RedisKey,
      ...elements: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.lpushx
- Defined in utils/RedisCommander.ts:5373
lpushx(
...args: [key: RedisKey, ...elements: (string | number | Buffer)[]],
): Promise<number>
Parameters
- ...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.lpushx
- Defined in utils/RedisCommander.ts:5380

lrange

lrange(
    key: RedisKey,
    start: string | number,
    stop: string | number,
    callback?: Callback<string[]>,
): Promise<string[]>
Returns a range of elements from a list.
- group: list
- complexity: O(S+N) where S is the distance of start offset from HEAD for small lists, from nearest end (HEAD or TAIL) for large lists; and N is the number of elements in the specified range.
- since: 1.0.0
Parameters
- key: RedisKey
- start: string | number
- stop: string | number
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.lrange
- Defined in utils/RedisCommander.ts:5390

lrangeBuffer

lrangeBuffer(
    key: RedisKey,
    start: string | number,
    stop: string | number,
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- start: string | number
- stop: string | number
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.lrangeBuffer
- Defined in utils/RedisCommander.ts:5396

lrem

lrem(
    key: RedisKey,
    count: string | number,
    element: string | number | Buffer,
    callback?: Callback<number>,
): Promise<number>
Removes elements from a list. Deletes the list if the last element was removed.
- group: list
- complexity: O(N+M) where N is the length of the list and M is the number of elements removed.
- since: 1.0.0
Parameters
- key: RedisKey
- count: string | number
- element: string | number | Buffer
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.lrem
- Defined in utils/RedisCommander.ts:5409

lset

lset(
    key: RedisKey,
    index: string | number,
    element: string | number | Buffer,
    callback?: Callback<"OK">,
): Promise<"OK">
Sets the value of an element in a list by its index.
- group: list
- complexity: O(N) where N is the length of the list. Setting either the first or the last element of the list is O(1).
- since: 1.0.0
Parameters
- key: RedisKey
- index: string | number
- element: string | number | Buffer
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.lset
- Defined in utils/RedisCommander.ts:5422

ltrim

ltrim(
    key: RedisKey,
    start: string | number,
    stop: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Removes elements from both ends a list. Deletes the list if all elements were trimmed.
- group: list
- complexity: O(N) where N is the number of elements to be removed by the operation.
- since: 1.0.0
Parameters
- key: RedisKey
- start: string | number
- stop: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.ltrim
- Defined in utils/RedisCommander.ts:5435

memory

memory(subcommand: "DOCTOR", callback?: Callback<string>): Promise<string>
Outputs a memory problems report.
- group: server
- complexity: O(1)
- since: 4.0.0
Parameters
- subcommand: "DOCTOR"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.memory
- Defined in utils/RedisCommander.ts:5448
memory(subcommand: "HELP", callback?: Callback<unknown[]>): Promise<unknown[]>
Returns helpful text about the different subcommands.
- group: server
- complexity: O(1)
- since: 4.0.0
Parameters
- subcommand: "HELP"
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.memory
- Defined in utils/RedisCommander.ts:5459
memory(subcommand: "MALLOC-STATS", callback?: Callback<string>): Promise<string>
Returns the allocator statistics.
- group: server
- complexity: Depends on how much memory is allocated, could be slow
- since: 4.0.0
Parameters
- subcommand: "MALLOC-STATS"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.memory
- Defined in utils/RedisCommander.ts:5470
memory(subcommand: "PURGE", callback?: Callback<"OK">): Promise<"OK">
Asks the allocator to release memory.
- group: server
- complexity: Depends on how much memory is allocated, could be slow
- since: 4.0.0
Parameters
- subcommand: "PURGE"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.memory
- Defined in utils/RedisCommander.ts:5481
memory(subcommand: "STATS", callback?: Callback<unknown[]>): Promise<unknown[]>
Returns details about memory usage.
- group: server
- complexity: O(1)
- since: 4.0.0
Parameters
- subcommand: "STATS"
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.memory
- Defined in utils/RedisCommander.ts:5489
memory(
    subcommand: "USAGE",
    key: RedisKey,
    callback?: Callback<number>,
): Promise<number>
Estimates the memory usage of a key.
- group: server
- complexity: O(N) where N is the number of samples.
- since: 4.0.0
Parameters
- subcommand: "USAGE"
- key: RedisKey
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.memory
- Defined in utils/RedisCommander.ts:5500
memory(
    subcommand: "USAGE",
    key: RedisKey,
    countToken: "SAMPLES",
    count: string | number,
    callback?: Callback<number>,
): Promise<number>
Parameters
- subcommand: "USAGE"
- key: RedisKey
- countToken: "SAMPLES"
- count: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.memory
- Defined in utils/RedisCommander.ts:5505

mget

mget(
...args: [...keys: RedisKey[], callback: Callback<string[]>],
): Promise<string[]>
Atomically returns the string values of one or more keys.
- group: string
- complexity: O(N) where N is the number of keys to retrieve.
- since: 1.0.0
Parameters
- ...args: [...keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Inherited from Commander.mget
- Defined in utils/RedisCommander.ts:5519
mget(
...args: [keys: RedisKey[], callback: Callback<string[]>],
): Promise<string[]>
Parameters
- ...args: [keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Inherited from Commander.mget
- Defined in utils/RedisCommander.ts:5525
mget(...args: RedisKey[]): Promise<string[]>
Parameters
- ...args: RedisKey[]
Returns Promise<string[]>
Inherited from Commander.mget
- Defined in utils/RedisCommander.ts:5531
mget(...args: [keys: RedisKey[]]): Promise<string[]>
Parameters
- ...args: [keys: RedisKey[]]
Returns Promise<string[]>
Inherited from Commander.mget
- Defined in utils/RedisCommander.ts:5535

mgetBuffer

mgetBuffer(
...args: [...keys: RedisKey[], callback: Callback<Buffer[]>],
): Promise<Buffer[]>
Parameters
- ...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Inherited from Commander.mgetBuffer
- Defined in utils/RedisCommander.ts:5522
mgetBuffer(
...args: [keys: RedisKey[], callback: Callback<Buffer[]>],
): Promise<Buffer[]>
Parameters
- ...args: [keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Inherited from Commander.mgetBuffer
- Defined in utils/RedisCommander.ts:5528
mgetBuffer(...args: RedisKey[]): Promise<Buffer[]>
Parameters
- ...args: RedisKey[]
Returns Promise<Buffer[]>
Inherited from Commander.mgetBuffer
- Defined in utils/RedisCommander.ts:5532
mgetBuffer(...args: [keys: RedisKey[]]): Promise<Buffer[]>
Parameters
- ...args: [keys: RedisKey[]]
Returns Promise<Buffer[]>
Inherited from Commander.mgetBuffer
- Defined in utils/RedisCommander.ts:5536

migrate

migrate(
    host: string | Buffer,
    port: string | number,
    key: RedisKey,
    destinationDb: string | number,
    timeout: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Atomically transfers a key from one instance to another.
- group: generic
- complexity: This command actually executes a DUMP+DEL in the source instance, and a RESTORE in the target instance. See the pages of these commands for time complexity. Also an O(N) data transfer between the two instances is performed.
- since: 2.6.0
Parameters
- host: string | Buffer
- port: string | number
- key: RedisKey
- destinationDb: string | number
- timeout: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5544
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        keysToken: "KEYS",
        ...keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      keysToken: "KEYS",
      ...keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5552
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        keysToken: "KEYS",
        keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      keysToken: "KEYS",
      keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5564
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        keysToken: "KEYS",
        ...keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      keysToken: "KEYS",
      ...keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5576
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        keysToken: "KEYS",
        keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      keysToken: "KEYS",
      keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5587
migrate(
    host: string | Buffer,
    port: string | number,
    key: RedisKey,
    destinationDb: string | number,
    timeout: string | number,
    authToken: "AUTH",
    auth: string | Buffer,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- host: string | Buffer
- port: string | number
- key: RedisKey
- destinationDb: string | number
- timeout: string | number
- authToken: "AUTH"
- auth: string | Buffer
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5598
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        authToken: "AUTH",
        auth: string | Buffer,
        keysToken: "KEYS",
        ...keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      authToken: "AUTH",
      auth: string | Buffer,
      keysToken: "KEYS",
      ...keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5608
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        authToken: "AUTH",
        auth: string | Buffer,
        keysToken: "KEYS",
        keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      authToken: "AUTH",
      auth: string | Buffer,
      keysToken: "KEYS",
      keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5622
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        authToken: "AUTH",
        auth: string | Buffer,
        keysToken: "KEYS",
        ...keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      authToken: "AUTH",
      auth: string | Buffer,
      keysToken: "KEYS",
      ...keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5636
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        authToken: "AUTH",
        auth: string | Buffer,
        keysToken: "KEYS",
        keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      authToken: "AUTH",
      auth: string | Buffer,
      keysToken: "KEYS",
      keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5649
migrate(
    host: string | Buffer,
    port: string | number,
    key: RedisKey,
    destinationDb: string | number,
    timeout: string | number,
    auth2Token: "AUTH2",
    username: string | Buffer,
    password: string | Buffer,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- host: string | Buffer
- port: string | number
- key: RedisKey
- destinationDb: string | number
- timeout: string | number
- auth2Token: "AUTH2"
- username: string | Buffer
- password: string | Buffer
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5662
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        auth2Token: "AUTH2",
        username: string | Buffer,
        password: string | Buffer,
        keysToken: "KEYS",
        ...keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      auth2Token: "AUTH2",
      username: string | Buffer,
      password: string | Buffer,
      keysToken: "KEYS",
      ...keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5673
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        auth2Token: "AUTH2",
        username: string | Buffer,
        password: string | Buffer,
        keysToken: "KEYS",
        keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      auth2Token: "AUTH2",
      username: string | Buffer,
      password: string | Buffer,
      keysToken: "KEYS",
      keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5688
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        auth2Token: "AUTH2",
        username: string | Buffer,
        password: string | Buffer,
        keysToken: "KEYS",
        ...keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      auth2Token: "AUTH2",
      username: string | Buffer,
      password: string | Buffer,
      keysToken: "KEYS",
      ...keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5703
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        auth2Token: "AUTH2",
        username: string | Buffer,
        password: string | Buffer,
        keysToken: "KEYS",
        keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      auth2Token: "AUTH2",
      username: string | Buffer,
      password: string | Buffer,
      keysToken: "KEYS",
      keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5717
migrate(
    host: string | Buffer,
    port: string | number,
    key: RedisKey,
    destinationDb: string | number,
    timeout: string | number,
    replace: "REPLACE",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- host: string | Buffer
- port: string | number
- key: RedisKey
- destinationDb: string | number
- timeout: string | number
- replace: "REPLACE"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5731
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        replace: "REPLACE",
        keysToken: "KEYS",
        ...keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      replace: "REPLACE",
      keysToken: "KEYS",
      ...keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5740
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        replace: "REPLACE",
        keysToken: "KEYS",
        keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      replace: "REPLACE",
      keysToken: "KEYS",
      keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5753
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        replace: "REPLACE",
        keysToken: "KEYS",
        ...keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      replace: "REPLACE",
      keysToken: "KEYS",
      ...keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5766
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        replace: "REPLACE",
        keysToken: "KEYS",
        keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      replace: "REPLACE",
      keysToken: "KEYS",
      keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5778
migrate(
    host: string | Buffer,
    port: string | number,
    key: RedisKey,
    destinationDb: string | number,
    timeout: string | number,
    replace: "REPLACE",
    authToken: "AUTH",
    auth: string | Buffer,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- host: string | Buffer
- port: string | number
- key: RedisKey
- destinationDb: string | number
- timeout: string | number
- replace: "REPLACE"
- authToken: "AUTH"
- auth: string | Buffer
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5790
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        replace: "REPLACE",
        authToken: "AUTH",
        auth: string | Buffer,
        keysToken: "KEYS",
        ...keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      replace: "REPLACE",
      authToken: "AUTH",
      auth: string | Buffer,
      keysToken: "KEYS",
      ...keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5801
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        replace: "REPLACE",
        authToken: "AUTH",
        auth: string | Buffer,
        keysToken: "KEYS",
        keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      replace: "REPLACE",
      authToken: "AUTH",
      auth: string | Buffer,
      keysToken: "KEYS",
      keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5816
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        replace: "REPLACE",
        authToken: "AUTH",
        auth: string | Buffer,
        keysToken: "KEYS",
        ...keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      replace: "REPLACE",
      authToken: "AUTH",
      auth: string | Buffer,
      keysToken: "KEYS",
      ...keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5831
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        replace: "REPLACE",
        authToken: "AUTH",
        auth: string | Buffer,
        keysToken: "KEYS",
        keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      replace: "REPLACE",
      authToken: "AUTH",
      auth: string | Buffer,
      keysToken: "KEYS",
      keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5845
migrate(
    host: string | Buffer,
    port: string | number,
    key: RedisKey,
    destinationDb: string | number,
    timeout: string | number,
    replace: "REPLACE",
    auth2Token: "AUTH2",
    username: string | Buffer,
    password: string | Buffer,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- host: string | Buffer
- port: string | number
- key: RedisKey
- destinationDb: string | number
- timeout: string | number
- replace: "REPLACE"
- auth2Token: "AUTH2"
- username: string | Buffer
- password: string | Buffer
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5859
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        replace: "REPLACE",
        auth2Token: "AUTH2",
        username: string | Buffer,
        password: string | Buffer,
        keysToken: "KEYS",
        ...keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      replace: "REPLACE",
      auth2Token: "AUTH2",
      username: string | Buffer,
      password: string | Buffer,
      keysToken: "KEYS",
      ...keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5871
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        replace: "REPLACE",
        auth2Token: "AUTH2",
        username: string | Buffer,
        password: string | Buffer,
        keysToken: "KEYS",
        keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      replace: "REPLACE",
      auth2Token: "AUTH2",
      username: string | Buffer,
      password: string | Buffer,
      keysToken: "KEYS",
      keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5887
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        replace: "REPLACE",
        auth2Token: "AUTH2",
        username: string | Buffer,
        password: string | Buffer,
        keysToken: "KEYS",
        ...keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      replace: "REPLACE",
      auth2Token: "AUTH2",
      username: string | Buffer,
      password: string | Buffer,
      keysToken: "KEYS",
      ...keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5903
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        replace: "REPLACE",
        auth2Token: "AUTH2",
        username: string | Buffer,
        password: string | Buffer,
        keysToken: "KEYS",
        keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      replace: "REPLACE",
      auth2Token: "AUTH2",
      username: string | Buffer,
      password: string | Buffer,
      keysToken: "KEYS",
      keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5918
migrate(
    host: string | Buffer,
    port: string | number,
    key: RedisKey,
    destinationDb: string | number,
    timeout: string | number,
    copy: "COPY",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- host: string | Buffer
- port: string | number
- key: RedisKey
- destinationDb: string | number
- timeout: string | number
- copy: "COPY"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5933
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        keysToken: "KEYS",
        ...keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      keysToken: "KEYS",
      ...keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5942
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        keysToken: "KEYS",
        keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      keysToken: "KEYS",
      keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5955
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        keysToken: "KEYS",
        ...keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      keysToken: "KEYS",
      ...keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5968
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        keysToken: "KEYS",
        keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      keysToken: "KEYS",
      keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5980
migrate(
    host: string | Buffer,
    port: string | number,
    key: RedisKey,
    destinationDb: string | number,
    timeout: string | number,
    copy: "COPY",
    authToken: "AUTH",
    auth: string | Buffer,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- host: string | Buffer
- port: string | number
- key: RedisKey
- destinationDb: string | number
- timeout: string | number
- copy: "COPY"
- authToken: "AUTH"
- auth: string | Buffer
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:5992
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        authToken: "AUTH",
        auth: string | Buffer,
        keysToken: "KEYS",
        ...keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      authToken: "AUTH",
      auth: string | Buffer,
      keysToken: "KEYS",
      ...keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6003
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        authToken: "AUTH",
        auth: string | Buffer,
        keysToken: "KEYS",
        keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      authToken: "AUTH",
      auth: string | Buffer,
      keysToken: "KEYS",
      keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6018
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        authToken: "AUTH",
        auth: string | Buffer,
        keysToken: "KEYS",
        ...keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      authToken: "AUTH",
      auth: string | Buffer,
      keysToken: "KEYS",
      ...keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6033
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        authToken: "AUTH",
        auth: string | Buffer,
        keysToken: "KEYS",
        keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      authToken: "AUTH",
      auth: string | Buffer,
      keysToken: "KEYS",
      keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6047
migrate(
    host: string | Buffer,
    port: string | number,
    key: RedisKey,
    destinationDb: string | number,
    timeout: string | number,
    copy: "COPY",
    auth2Token: "AUTH2",
    username: string | Buffer,
    password: string | Buffer,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- host: string | Buffer
- port: string | number
- key: RedisKey
- destinationDb: string | number
- timeout: string | number
- copy: "COPY"
- auth2Token: "AUTH2"
- username: string | Buffer
- password: string | Buffer
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6061
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        auth2Token: "AUTH2",
        username: string | Buffer,
        password: string | Buffer,
        keysToken: "KEYS",
        ...keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      auth2Token: "AUTH2",
      username: string | Buffer,
      password: string | Buffer,
      keysToken: "KEYS",
      ...keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6073
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        auth2Token: "AUTH2",
        username: string | Buffer,
        password: string | Buffer,
        keysToken: "KEYS",
        keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      auth2Token: "AUTH2",
      username: string | Buffer,
      password: string | Buffer,
      keysToken: "KEYS",
      keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6089
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        auth2Token: "AUTH2",
        username: string | Buffer,
        password: string | Buffer,
        keysToken: "KEYS",
        ...keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      auth2Token: "AUTH2",
      username: string | Buffer,
      password: string | Buffer,
      keysToken: "KEYS",
      ...keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6105
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        auth2Token: "AUTH2",
        username: string | Buffer,
        password: string | Buffer,
        keysToken: "KEYS",
        keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      auth2Token: "AUTH2",
      username: string | Buffer,
      password: string | Buffer,
      keysToken: "KEYS",
      keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6120
migrate(
    host: string | Buffer,
    port: string | number,
    key: RedisKey,
    destinationDb: string | number,
    timeout: string | number,
    copy: "COPY",
    replace: "REPLACE",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- host: string | Buffer
- port: string | number
- key: RedisKey
- destinationDb: string | number
- timeout: string | number
- copy: "COPY"
- replace: "REPLACE"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6135
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        replace: "REPLACE",
        keysToken: "KEYS",
        ...keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      replace: "REPLACE",
      keysToken: "KEYS",
      ...keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6145
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        replace: "REPLACE",
        keysToken: "KEYS",
        keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      replace: "REPLACE",
      keysToken: "KEYS",
      keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6159
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        replace: "REPLACE",
        keysToken: "KEYS",
        ...keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      replace: "REPLACE",
      keysToken: "KEYS",
      ...keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6173
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        replace: "REPLACE",
        keysToken: "KEYS",
        keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      replace: "REPLACE",
      keysToken: "KEYS",
      keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6186
migrate(
    host: string | Buffer,
    port: string | number,
    key: RedisKey,
    destinationDb: string | number,
    timeout: string | number,
    copy: "COPY",
    replace: "REPLACE",
    authToken: "AUTH",
    auth: string | Buffer,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- host: string | Buffer
- port: string | number
- key: RedisKey
- destinationDb: string | number
- timeout: string | number
- copy: "COPY"
- replace: "REPLACE"
- authToken: "AUTH"
- auth: string | Buffer
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6199
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        replace: "REPLACE",
        authToken: "AUTH",
        auth: string | Buffer,
        keysToken: "KEYS",
        ...keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      replace: "REPLACE",
      authToken: "AUTH",
      auth: string | Buffer,
      keysToken: "KEYS",
      ...keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6211
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        replace: "REPLACE",
        authToken: "AUTH",
        auth: string | Buffer,
        keysToken: "KEYS",
        keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      replace: "REPLACE",
      authToken: "AUTH",
      auth: string | Buffer,
      keysToken: "KEYS",
      keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6227
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        replace: "REPLACE",
        authToken: "AUTH",
        auth: string | Buffer,
        keysToken: "KEYS",
        ...keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      replace: "REPLACE",
      authToken: "AUTH",
      auth: string | Buffer,
      keysToken: "KEYS",
      ...keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6243
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        replace: "REPLACE",
        authToken: "AUTH",
        auth: string | Buffer,
        keysToken: "KEYS",
        keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      replace: "REPLACE",
      authToken: "AUTH",
      auth: string | Buffer,
      keysToken: "KEYS",
      keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6258
migrate(
    host: string | Buffer,
    port: string | number,
    key: RedisKey,
    destinationDb: string | number,
    timeout: string | number,
    copy: "COPY",
    replace: "REPLACE",
    auth2Token: "AUTH2",
    username: string | Buffer,
    password: string | Buffer,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- host: string | Buffer
- port: string | number
- key: RedisKey
- destinationDb: string | number
- timeout: string | number
- copy: "COPY"
- replace: "REPLACE"
- auth2Token: "AUTH2"
- username: string | Buffer
- password: string | Buffer
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6273
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        replace: "REPLACE",
        auth2Token: "AUTH2",
        username: string | Buffer,
        password: string | Buffer,
        keysToken: "KEYS",
        ...keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      replace: "REPLACE",
      auth2Token: "AUTH2",
      username: string | Buffer,
      password: string | Buffer,
      keysToken: "KEYS",
      ...keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6286
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        replace: "REPLACE",
        auth2Token: "AUTH2",
        username: string | Buffer,
        password: string | Buffer,
        keysToken: "KEYS",
        keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      replace: "REPLACE",
      auth2Token: "AUTH2",
      username: string | Buffer,
      password: string | Buffer,
      keysToken: "KEYS",
      keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6303
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        replace: "REPLACE",
        auth2Token: "AUTH2",
        username: string | Buffer,
        password: string | Buffer,
        keysToken: "KEYS",
        ...keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      replace: "REPLACE",
      auth2Token: "AUTH2",
      username: string | Buffer,
      password: string | Buffer,
      keysToken: "KEYS",
      ...keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6320
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        key: RedisKey,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        replace: "REPLACE",
        auth2Token: "AUTH2",
        username: string | Buffer,
        password: string | Buffer,
        keysToken: "KEYS",
        keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      key: RedisKey,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      replace: "REPLACE",
      auth2Token: "AUTH2",
      username: string | Buffer,
      password: string | Buffer,
      keysToken: "KEYS",
      keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6336
migrate(
    host: string | Buffer,
    port: string | number,
    destinationDb: string | number,
    timeout: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- host: string | Buffer
- port: string | number
- destinationDb: string | number
- timeout: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6352
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        keysToken: "KEYS",
        ...keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      keysToken: "KEYS",
      ...keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6359
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        keysToken: "KEYS",
        keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      keysToken: "KEYS",
      keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6370
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        keysToken: "KEYS",
        ...keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      keysToken: "KEYS",
      ...keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6381
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        keysToken: "KEYS",
        keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      keysToken: "KEYS",
      keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6391
migrate(
    host: string | Buffer,
    port: string | number,
    destinationDb: string | number,
    timeout: string | number,
    authToken: "AUTH",
    auth: string | Buffer,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- host: string | Buffer
- port: string | number
- destinationDb: string | number
- timeout: string | number
- authToken: "AUTH"
- auth: string | Buffer
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6401
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        authToken: "AUTH",
        auth: string | Buffer,
        keysToken: "KEYS",
        ...keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      authToken: "AUTH",
      auth: string | Buffer,
      keysToken: "KEYS",
      ...keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6410
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        authToken: "AUTH",
        auth: string | Buffer,
        keysToken: "KEYS",
        keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      authToken: "AUTH",
      auth: string | Buffer,
      keysToken: "KEYS",
      keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6423
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        authToken: "AUTH",
        auth: string | Buffer,
        keysToken: "KEYS",
        ...keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      authToken: "AUTH",
      auth: string | Buffer,
      keysToken: "KEYS",
      ...keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6436
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        authToken: "AUTH",
        auth: string | Buffer,
        keysToken: "KEYS",
        keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      authToken: "AUTH",
      auth: string | Buffer,
      keysToken: "KEYS",
      keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6448
migrate(
    host: string | Buffer,
    port: string | number,
    destinationDb: string | number,
    timeout: string | number,
    auth2Token: "AUTH2",
    username: string | Buffer,
    password: string | Buffer,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- host: string | Buffer
- port: string | number
- destinationDb: string | number
- timeout: string | number
- auth2Token: "AUTH2"
- username: string | Buffer
- password: string | Buffer
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6460
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        auth2Token: "AUTH2",
        username: string | Buffer,
        password: string | Buffer,
        keysToken: "KEYS",
        ...keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      auth2Token: "AUTH2",
      username: string | Buffer,
      password: string | Buffer,
      keysToken: "KEYS",
      ...keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6470
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        auth2Token: "AUTH2",
        username: string | Buffer,
        password: string | Buffer,
        keysToken: "KEYS",
        keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      auth2Token: "AUTH2",
      username: string | Buffer,
      password: string | Buffer,
      keysToken: "KEYS",
      keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6484
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        auth2Token: "AUTH2",
        username: string | Buffer,
        password: string | Buffer,
        keysToken: "KEYS",
        ...keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      auth2Token: "AUTH2",
      username: string | Buffer,
      password: string | Buffer,
      keysToken: "KEYS",
      ...keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6498
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        auth2Token: "AUTH2",
        username: string | Buffer,
        password: string | Buffer,
        keysToken: "KEYS",
        keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      auth2Token: "AUTH2",
      username: string | Buffer,
      password: string | Buffer,
      keysToken: "KEYS",
      keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6511
migrate(
    host: string | Buffer,
    port: string | number,
    destinationDb: string | number,
    timeout: string | number,
    replace: "REPLACE",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- host: string | Buffer
- port: string | number
- destinationDb: string | number
- timeout: string | number
- replace: "REPLACE"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6524
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        replace: "REPLACE",
        keysToken: "KEYS",
        ...keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      replace: "REPLACE",
      keysToken: "KEYS",
      ...keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6532
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        replace: "REPLACE",
        keysToken: "KEYS",
        keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      replace: "REPLACE",
      keysToken: "KEYS",
      keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6544
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        replace: "REPLACE",
        keysToken: "KEYS",
        ...keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      replace: "REPLACE",
      keysToken: "KEYS",
      ...keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6556
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        replace: "REPLACE",
        keysToken: "KEYS",
        keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      replace: "REPLACE",
      keysToken: "KEYS",
      keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6567
migrate(
    host: string | Buffer,
    port: string | number,
    destinationDb: string | number,
    timeout: string | number,
    replace: "REPLACE",
    authToken: "AUTH",
    auth: string | Buffer,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- host: string | Buffer
- port: string | number
- destinationDb: string | number
- timeout: string | number
- replace: "REPLACE"
- authToken: "AUTH"
- auth: string | Buffer
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6578
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        replace: "REPLACE",
        authToken: "AUTH",
        auth: string | Buffer,
        keysToken: "KEYS",
        ...keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      replace: "REPLACE",
      authToken: "AUTH",
      auth: string | Buffer,
      keysToken: "KEYS",
      ...keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6588
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        replace: "REPLACE",
        authToken: "AUTH",
        auth: string | Buffer,
        keysToken: "KEYS",
        keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      replace: "REPLACE",
      authToken: "AUTH",
      auth: string | Buffer,
      keysToken: "KEYS",
      keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6602
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        replace: "REPLACE",
        authToken: "AUTH",
        auth: string | Buffer,
        keysToken: "KEYS",
        ...keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      replace: "REPLACE",
      authToken: "AUTH",
      auth: string | Buffer,
      keysToken: "KEYS",
      ...keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6616
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        replace: "REPLACE",
        authToken: "AUTH",
        auth: string | Buffer,
        keysToken: "KEYS",
        keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      replace: "REPLACE",
      authToken: "AUTH",
      auth: string | Buffer,
      keysToken: "KEYS",
      keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6629
migrate(
    host: string | Buffer,
    port: string | number,
    destinationDb: string | number,
    timeout: string | number,
    replace: "REPLACE",
    auth2Token: "AUTH2",
    username: string | Buffer,
    password: string | Buffer,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- host: string | Buffer
- port: string | number
- destinationDb: string | number
- timeout: string | number
- replace: "REPLACE"
- auth2Token: "AUTH2"
- username: string | Buffer
- password: string | Buffer
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6642
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        replace: "REPLACE",
        auth2Token: "AUTH2",
        username: string | Buffer,
        password: string | Buffer,
        keysToken: "KEYS",
        ...keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      replace: "REPLACE",
      auth2Token: "AUTH2",
      username: string | Buffer,
      password: string | Buffer,
      keysToken: "KEYS",
      ...keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6653
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        replace: "REPLACE",
        auth2Token: "AUTH2",
        username: string | Buffer,
        password: string | Buffer,
        keysToken: "KEYS",
        keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      replace: "REPLACE",
      auth2Token: "AUTH2",
      username: string | Buffer,
      password: string | Buffer,
      keysToken: "KEYS",
      keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6668
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        replace: "REPLACE",
        auth2Token: "AUTH2",
        username: string | Buffer,
        password: string | Buffer,
        keysToken: "KEYS",
        ...keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      replace: "REPLACE",
      auth2Token: "AUTH2",
      username: string | Buffer,
      password: string | Buffer,
      keysToken: "KEYS",
      ...keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6683
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        replace: "REPLACE",
        auth2Token: "AUTH2",
        username: string | Buffer,
        password: string | Buffer,
        keysToken: "KEYS",
        keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      replace: "REPLACE",
      auth2Token: "AUTH2",
      username: string | Buffer,
      password: string | Buffer,
      keysToken: "KEYS",
      keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6697
migrate(
    host: string | Buffer,
    port: string | number,
    destinationDb: string | number,
    timeout: string | number,
    copy: "COPY",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- host: string | Buffer
- port: string | number
- destinationDb: string | number
- timeout: string | number
- copy: "COPY"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6711
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        keysToken: "KEYS",
        ...keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      keysToken: "KEYS",
      ...keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6719
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        keysToken: "KEYS",
        keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      keysToken: "KEYS",
      keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6731
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        keysToken: "KEYS",
        ...keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      keysToken: "KEYS",
      ...keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6743
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        keysToken: "KEYS",
        keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      keysToken: "KEYS",
      keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6754
migrate(
    host: string | Buffer,
    port: string | number,
    destinationDb: string | number,
    timeout: string | number,
    copy: "COPY",
    authToken: "AUTH",
    auth: string | Buffer,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- host: string | Buffer
- port: string | number
- destinationDb: string | number
- timeout: string | number
- copy: "COPY"
- authToken: "AUTH"
- auth: string | Buffer
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6765
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        authToken: "AUTH",
        auth: string | Buffer,
        keysToken: "KEYS",
        ...keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      authToken: "AUTH",
      auth: string | Buffer,
      keysToken: "KEYS",
      ...keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6775
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        authToken: "AUTH",
        auth: string | Buffer,
        keysToken: "KEYS",
        keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      authToken: "AUTH",
      auth: string | Buffer,
      keysToken: "KEYS",
      keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6789
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        authToken: "AUTH",
        auth: string | Buffer,
        keysToken: "KEYS",
        ...keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      authToken: "AUTH",
      auth: string | Buffer,
      keysToken: "KEYS",
      ...keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6803
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        authToken: "AUTH",
        auth: string | Buffer,
        keysToken: "KEYS",
        keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      authToken: "AUTH",
      auth: string | Buffer,
      keysToken: "KEYS",
      keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6816
migrate(
    host: string | Buffer,
    port: string | number,
    destinationDb: string | number,
    timeout: string | number,
    copy: "COPY",
    auth2Token: "AUTH2",
    username: string | Buffer,
    password: string | Buffer,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- host: string | Buffer
- port: string | number
- destinationDb: string | number
- timeout: string | number
- copy: "COPY"
- auth2Token: "AUTH2"
- username: string | Buffer
- password: string | Buffer
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6829
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        auth2Token: "AUTH2",
        username: string | Buffer,
        password: string | Buffer,
        keysToken: "KEYS",
        ...keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      auth2Token: "AUTH2",
      username: string | Buffer,
      password: string | Buffer,
      keysToken: "KEYS",
      ...keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6840
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        auth2Token: "AUTH2",
        username: string | Buffer,
        password: string | Buffer,
        keysToken: "KEYS",
        keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      auth2Token: "AUTH2",
      username: string | Buffer,
      password: string | Buffer,
      keysToken: "KEYS",
      keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6855
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        auth2Token: "AUTH2",
        username: string | Buffer,
        password: string | Buffer,
        keysToken: "KEYS",
        ...keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      auth2Token: "AUTH2",
      username: string | Buffer,
      password: string | Buffer,
      keysToken: "KEYS",
      ...keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6870
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        auth2Token: "AUTH2",
        username: string | Buffer,
        password: string | Buffer,
        keysToken: "KEYS",
        keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      auth2Token: "AUTH2",
      username: string | Buffer,
      password: string | Buffer,
      keysToken: "KEYS",
      keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6884
migrate(
    host: string | Buffer,
    port: string | number,
    destinationDb: string | number,
    timeout: string | number,
    copy: "COPY",
    replace: "REPLACE",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- host: string | Buffer
- port: string | number
- destinationDb: string | number
- timeout: string | number
- copy: "COPY"
- replace: "REPLACE"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6898
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        replace: "REPLACE",
        keysToken: "KEYS",
        ...keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      replace: "REPLACE",
      keysToken: "KEYS",
      ...keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6907
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        replace: "REPLACE",
        keysToken: "KEYS",
        keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      replace: "REPLACE",
      keysToken: "KEYS",
      keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6920
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        replace: "REPLACE",
        keysToken: "KEYS",
        ...keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      replace: "REPLACE",
      keysToken: "KEYS",
      ...keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6933
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        replace: "REPLACE",
        keysToken: "KEYS",
        keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      replace: "REPLACE",
      keysToken: "KEYS",
      keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6945
migrate(
    host: string | Buffer,
    port: string | number,
    destinationDb: string | number,
    timeout: string | number,
    copy: "COPY",
    replace: "REPLACE",
    authToken: "AUTH",
    auth: string | Buffer,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- host: string | Buffer
- port: string | number
- destinationDb: string | number
- timeout: string | number
- copy: "COPY"
- replace: "REPLACE"
- authToken: "AUTH"
- auth: string | Buffer
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6957
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        replace: "REPLACE",
        authToken: "AUTH",
        auth: string | Buffer,
        keysToken: "KEYS",
        ...keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      replace: "REPLACE",
      authToken: "AUTH",
      auth: string | Buffer,
      keysToken: "KEYS",
      ...keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6968
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        replace: "REPLACE",
        authToken: "AUTH",
        auth: string | Buffer,
        keysToken: "KEYS",
        keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      replace: "REPLACE",
      authToken: "AUTH",
      auth: string | Buffer,
      keysToken: "KEYS",
      keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6983
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        replace: "REPLACE",
        authToken: "AUTH",
        auth: string | Buffer,
        keysToken: "KEYS",
        ...keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      replace: "REPLACE",
      authToken: "AUTH",
      auth: string | Buffer,
      keysToken: "KEYS",
      ...keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:6998
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        replace: "REPLACE",
        authToken: "AUTH",
        auth: string | Buffer,
        keysToken: "KEYS",
        keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      replace: "REPLACE",
      authToken: "AUTH",
      auth: string | Buffer,
      keysToken: "KEYS",
      keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:7012
migrate(
    host: string | Buffer,
    port: string | number,
    destinationDb: string | number,
    timeout: string | number,
    copy: "COPY",
    replace: "REPLACE",
    auth2Token: "AUTH2",
    username: string | Buffer,
    password: string | Buffer,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- host: string | Buffer
- port: string | number
- destinationDb: string | number
- timeout: string | number
- copy: "COPY"
- replace: "REPLACE"
- auth2Token: "AUTH2"
- username: string | Buffer
- password: string | Buffer
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:7026
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        replace: "REPLACE",
        auth2Token: "AUTH2",
        username: string | Buffer,
        password: string | Buffer,
        keysToken: "KEYS",
        ...keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      replace: "REPLACE",
      auth2Token: "AUTH2",
      username: string | Buffer,
      password: string | Buffer,
      keysToken: "KEYS",
      ...keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:7038
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        replace: "REPLACE",
        auth2Token: "AUTH2",
        username: string | Buffer,
        password: string | Buffer,
        keysToken: "KEYS",
        keys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      replace: "REPLACE",
      auth2Token: "AUTH2",
      username: string | Buffer,
      password: string | Buffer,
      keysToken: "KEYS",
      keys: RedisKey[],
      callback: Callback<"OK">,
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:7054
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        replace: "REPLACE",
        auth2Token: "AUTH2",
        username: string | Buffer,
        password: string | Buffer,
        keysToken: "KEYS",
        ...keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      replace: "REPLACE",
      auth2Token: "AUTH2",
      username: string | Buffer,
      password: string | Buffer,
      keysToken: "KEYS",
      ...keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:7070
migrate(
    ...args: [
        host: string
        | Buffer,
        port: string | number,
        destinationDb: string | number,
        timeout: string | number,
        copy: "COPY",
        replace: "REPLACE",
        auth2Token: "AUTH2",
        username: string | Buffer,
        password: string | Buffer,
        keysToken: "KEYS",
        keys: RedisKey[],
    ],
): Promise<"OK">
Parameters
- ...args: [
      host: string
      | Buffer,
      port: string | number,
      destinationDb: string | number,
      timeout: string | number,
      copy: "COPY",
      replace: "REPLACE",
      auth2Token: "AUTH2",
      username: string | Buffer,
      password: string | Buffer,
      keysToken: "KEYS",
      keys: RedisKey[],
  ]
Returns Promise<"OK">
Inherited from Commander.migrate
- Defined in utils/RedisCommander.ts:7085

module

module(subcommand: "HELP", callback?: Callback<unknown>): Promise<unknown>
Returns helpful text about the different subcommands.
- group: server
- complexity: O(1)
- since: 5.0.0
Parameters
- subcommand: "HELP"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.module
- Defined in utils/RedisCommander.ts:7107
module(subcommand: "LIST", callback?: Callback<unknown>): Promise<unknown>
Returns all loaded modules.
- group: server
- complexity: O(N) where N is the number of loaded modules.
- since: 4.0.0
Parameters
- subcommand: "LIST"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.module
- Defined in utils/RedisCommander.ts:7118
module(
    subcommand: "LOAD",
    path: string | Buffer,
    callback?: Callback<unknown>,
): Promise<unknown>
Loads a module.
- group: server
- complexity: O(1)
- since: 4.0.0
Parameters
- subcommand: "LOAD"
- path: string | Buffer
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.module
- Defined in utils/RedisCommander.ts:7129
module(
    ...args: [
        subcommand: "LOAD",
        path: string
        | Buffer,
        ...args: (string | number | Buffer)[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      subcommand: "LOAD",
      path: string
      | Buffer,
      ...args: (string | number | Buffer)[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.module
- Defined in utils/RedisCommander.ts:7134
module(
    ...args: [
        subcommand: "LOAD",
        path: string
        | Buffer,
        ...args: (string | number | Buffer)[],
    ],
): Promise<unknown>
Parameters
- ...args: [
      subcommand: "LOAD",
      path: string
      | Buffer,
      ...args: (string | number | Buffer)[],
  ]
Returns Promise<unknown>
Inherited from Commander.module
- Defined in utils/RedisCommander.ts:7142
module(
    subcommand: "LOADEX",
    path: string | Buffer,
    callback?: Callback<unknown>,
): Promise<unknown>
Loads a module using extended parameters.
- group: server
- complexity: O(1)
- since: 7.0.0
Parameters
- subcommand: "LOADEX"
- path: string | Buffer
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.module
- Defined in utils/RedisCommander.ts:7156
module(
    ...args: [
        subcommand: "LOADEX",
        path: string
        | Buffer,
        argsToken: "ARGS",
        ...args: (string | number | Buffer)[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      subcommand: "LOADEX",
      path: string
      | Buffer,
      argsToken: "ARGS",
      ...args: (string | number | Buffer)[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.module
- Defined in utils/RedisCommander.ts:7161
module(
    ...args: [
        subcommand: "LOADEX",
        path: string
        | Buffer,
        argsToken: "ARGS",
        ...args: (string | number | Buffer)[],
    ],
): Promise<unknown>
Parameters
- ...args: [
      subcommand: "LOADEX",
      path: string
      | Buffer,
      argsToken: "ARGS",
      ...args: (string | number | Buffer)[],
  ]
Returns Promise<unknown>
Inherited from Commander.module
- Defined in utils/RedisCommander.ts:7170
module(
    ...args: [
        subcommand: "LOADEX",
        path: string
        | Buffer,
        configsToken: "CONFIG",
        ...configs: (string | number | Buffer)[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      subcommand: "LOADEX",
      path: string
      | Buffer,
      configsToken: "CONFIG",
      ...configs: (string | number | Buffer)[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.module
- Defined in utils/RedisCommander.ts:7178
module(
    ...args: [
        subcommand: "LOADEX",
        path: string
        | Buffer,
        configsToken: "CONFIG",
        ...configs: (string | number | Buffer)[],
    ],
): Promise<unknown>
Parameters
- ...args: [
      subcommand: "LOADEX",
      path: string
      | Buffer,
      configsToken: "CONFIG",
      ...configs: (string | number | Buffer)[],
  ]
Returns Promise<unknown>
Inherited from Commander.module
- Defined in utils/RedisCommander.ts:7187
module(
    ...args: [
        subcommand: "LOADEX",
        path: string
        | Buffer,
        configsToken: "CONFIG",
        ...args: RedisValue[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      subcommand: "LOADEX",
      path: string
      | Buffer,
      configsToken: "CONFIG",
      ...args: RedisValue[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.module
- Defined in utils/RedisCommander.ts:7195
module(
    ...args: [
        subcommand: "LOADEX",
        path: string
        | Buffer,
        configsToken: "CONFIG",
        ...args: RedisValue[],
    ],
): Promise<unknown>
Parameters
- ...args: [
      subcommand: "LOADEX",
      path: string
      | Buffer,
      configsToken: "CONFIG",
      ...args: RedisValue[],
  ]
Returns Promise<unknown>
Inherited from Commander.module
- Defined in utils/RedisCommander.ts:7204
module(
    subcommand: "UNLOAD",
    name: string | Buffer,
    callback?: Callback<unknown>,
): Promise<unknown>
Unloads a module.
- group: server
- complexity: O(1)
- since: 4.0.0
Parameters
- subcommand: "UNLOAD"
- name: string | Buffer
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.module
- Defined in utils/RedisCommander.ts:7219

move

move(
    key: RedisKey,
    db: string | number,
    callback?: Callback<number>,
): Promise<number>
Moves a key to another database.
- group: generic
- complexity: O(1)
- since: 1.0.0
Parameters
- key: RedisKey
- db: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.move
- Defined in utils/RedisCommander.ts:7231

mset

mset(object: object, callback?: Callback<"OK">): Promise<"OK">
Atomically creates or modifies the string values of one or more keys.
- group: string
- complexity: O(N) where N is the number of keys to set.
- since: 1.0.1
Parameters
- object: object
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.mset
- Defined in utils/RedisCommander.ts:7243
mset(
map: Map<string | number | Buffer, string | number | Buffer>,
callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- map: Map<string | number | Buffer, string | number | Buffer>
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.mset
- Defined in utils/RedisCommander.ts:7244
mset(
...args: [...data: (number | RedisKey)[], callback: Callback<"OK">],
): Promise<"OK">
Parameters
- ...args: [...data: (number | RedisKey)[], callback: Callback<"OK">]
Returns Promise<"OK">
Inherited from Commander.mset
- Defined in utils/RedisCommander.ts:7248
mset(...args: (number | RedisKey)[]): Promise<"OK">
Parameters
- ...args: (number | RedisKey)[]
Returns Promise<"OK">
Inherited from Commander.mset
- Defined in utils/RedisCommander.ts:7254

msetnx

msetnx(object: object, callback?: Callback<"OK">): Promise<"OK">
Atomically modifies the string values of one or more keys only when all keys don't exist.
- group: string
- complexity: O(N) where N is the number of keys to set.
- since: 1.0.1
Parameters
- object: object
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.msetnx
- Defined in utils/RedisCommander.ts:7264
msetnx(
map: Map<string | number | Buffer, string | number | Buffer>,
callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- map: Map<string | number | Buffer, string | number | Buffer>
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.msetnx
- Defined in utils/RedisCommander.ts:7265
msetnx(
...args: [...data: (number | RedisKey)[], callback: Callback<number>],
): Promise<number>
Parameters
- ...args: [...data: (number | RedisKey)[], callback: Callback<number>]
Returns Promise<number>
Inherited from Commander.msetnx
- Defined in utils/RedisCommander.ts:7269
msetnx(...args: (number | RedisKey)[]): Promise<number>
Parameters
- ...args: (number | RedisKey)[]
Returns Promise<number>
Inherited from Commander.msetnx
- Defined in utils/RedisCommander.ts:7275

multi

multi(options: { pipeline: false }): Promise<"OK">
Parameters
- options: { pipeline: false }
Returns Promise<"OK">
- Defined in transaction.ts:9
multi(): ChainableCommander
Returns ChainableCommander
- Defined in transaction.ts:10
multi(options: { pipeline: true }): ChainableCommander
Parameters
- options: { pipeline: true }
Returns ChainableCommander
- Defined in transaction.ts:11
multi(commands?: unknown[][]): ChainableCommander
Parameters
- Optionalcommands: unknown[][]
Returns ChainableCommander
- Defined in transaction.ts:12

nodes

nodes(role?: NodeRole): Redis[]
Get nodes with the specified role
Parameters
- role: NodeRole = "all"
Returns Redis[]
- Defined in cluster/index.ts:378

object

object(
    subcommand: "ENCODING",
    key: RedisKey,
    callback?: Callback<unknown>,
): Promise<unknown>
Returns the internal encoding of an object.
- group: generic
- complexity: O(1)
- since: 2.2.3
Parameters
- subcommand: "ENCODING"
- key: RedisKey
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.object
- Defined in utils/RedisCommander.ts:7285
object(
    subcommand: "FREQ",
    key: RedisKey,
    callback?: Callback<unknown>,
): Promise<unknown>
Returns the logarithmic access frequency counter of an object.
- group: generic
- complexity: O(1)
- since: 4.0.0
Parameters
- subcommand: "FREQ"
- key: RedisKey
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.object
- Defined in utils/RedisCommander.ts:7297
object(subcommand: "HELP", callback?: Callback<unknown>): Promise<unknown>
Returns helpful text about the different subcommands.
- group: generic
- complexity: O(1)
- since: 6.2.0
Parameters
- subcommand: "HELP"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.object
- Defined in utils/RedisCommander.ts:7309
object(
    subcommand: "IDLETIME",
    key: RedisKey,
    callback?: Callback<unknown>,
): Promise<unknown>
Returns the time since the last access to an object.
- group: generic
- complexity: O(1)
- since: 2.2.3
Parameters
- subcommand: "IDLETIME"
- key: RedisKey
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.object
- Defined in utils/RedisCommander.ts:7320
object(
    subcommand: "REFCOUNT",
    key: RedisKey,
    callback?: Callback<unknown>,
): Promise<unknown>
Returns the reference count of a value of a key.
- group: generic
- complexity: O(1)
- since: 2.2.3
Parameters
- subcommand: "REFCOUNT"
- key: RedisKey
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.object
- Defined in utils/RedisCommander.ts:7332

persist

persist(key: RedisKey, callback?: Callback<number>): Promise<number>
Removes the expiration time of a key.
- group: generic
- complexity: O(1)
- since: 2.2.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.persist
- Defined in utils/RedisCommander.ts:7344

pexpire

pexpire(
    key: RedisKey,
    milliseconds: string | number,
    callback?: Callback<number>,
): Promise<number>
Sets the expiration time of a key in milliseconds.
- group: generic
- complexity: O(1)
- since: 2.6.0
Parameters
- key: RedisKey
- milliseconds: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.pexpire
- Defined in utils/RedisCommander.ts:7352
pexpire(
    key: RedisKey,
    milliseconds: string | number,
    nx: "NX",
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- milliseconds: string | number
- nx: "NX"
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.pexpire
- Defined in utils/RedisCommander.ts:7357
pexpire(
    key: RedisKey,
    milliseconds: string | number,
    xx: "XX",
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- milliseconds: string | number
- xx: "XX"
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.pexpire
- Defined in utils/RedisCommander.ts:7363
pexpire(
    key: RedisKey,
    milliseconds: string | number,
    gt: "GT",
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- milliseconds: string | number
- gt: "GT"
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.pexpire
- Defined in utils/RedisCommander.ts:7369
pexpire(
    key: RedisKey,
    milliseconds: string | number,
    lt: "LT",
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- milliseconds: string | number
- lt: "LT"
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.pexpire
- Defined in utils/RedisCommander.ts:7375

pexpireat

pexpireat(
    key: RedisKey,
    unixTimeMilliseconds: string | number,
    callback?: Callback<number>,
): Promise<number>
Sets the expiration time of a key to a Unix milliseconds timestamp.
- group: generic
- complexity: O(1)
- since: 2.6.0
Parameters
- key: RedisKey
- unixTimeMilliseconds: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.pexpireat
- Defined in utils/RedisCommander.ts:7388
pexpireat(
    key: RedisKey,
    unixTimeMilliseconds: string | number,
    nx: "NX",
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- unixTimeMilliseconds: string | number
- nx: "NX"
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.pexpireat
- Defined in utils/RedisCommander.ts:7393
pexpireat(
    key: RedisKey,
    unixTimeMilliseconds: string | number,
    xx: "XX",
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- unixTimeMilliseconds: string | number
- xx: "XX"
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.pexpireat
- Defined in utils/RedisCommander.ts:7399
pexpireat(
    key: RedisKey,
    unixTimeMilliseconds: string | number,
    gt: "GT",
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- unixTimeMilliseconds: string | number
- gt: "GT"
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.pexpireat
- Defined in utils/RedisCommander.ts:7405
pexpireat(
    key: RedisKey,
    unixTimeMilliseconds: string | number,
    lt: "LT",
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- unixTimeMilliseconds: string | number
- lt: "LT"
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.pexpireat
- Defined in utils/RedisCommander.ts:7411

pexpiretime

pexpiretime(key: RedisKey, callback?: Callback<number>): Promise<number>
Returns the expiration time of a key as a Unix milliseconds timestamp.
- group: generic
- complexity: O(1)
- since: 7.0.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.pexpiretime
- Defined in utils/RedisCommander.ts:7424

pfadd

pfadd(key: RedisKey, callback?: Callback<number>): Promise<number>
Adds elements to a HyperLogLog key. Creates the key if it doesn't exist.
- group: hyperloglog
- complexity: O(1) to add every element.
- since: 2.8.9
Parameters
- key: RedisKey
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.pfadd
- Defined in utils/RedisCommander.ts:7435
pfadd(
    ...args: [
        key: RedisKey,
        ...elements: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      key: RedisKey,
      ...elements: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.pfadd
- Defined in utils/RedisCommander.ts:7436
pfadd(
...args: [key: RedisKey, ...elements: (string | number | Buffer)[]],
): Promise<number>
Parameters
- ...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.pfadd
- Defined in utils/RedisCommander.ts:7443

pfcount

pfcount(
...args: [...keys: RedisKey[], callback: Callback<number>],
): Promise<number>
Returns the approximated cardinality of the set(s) observed by the HyperLogLog key(s).
- group: hyperloglog
- complexity: O(1) with a very small average constant time when called with a single key. O(N) with N being the number of keys, and much bigger constant times, when called with multiple keys.
- since: 2.8.9
Parameters
- ...args: [...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Inherited from Commander.pfcount
- Defined in utils/RedisCommander.ts:7453
pfcount(
...args: [keys: RedisKey[], callback: Callback<number>],
): Promise<number>
Parameters
- ...args: [keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Inherited from Commander.pfcount
- Defined in utils/RedisCommander.ts:7456
pfcount(...args: RedisKey[]): Promise<number>
Parameters
- ...args: RedisKey[]
Returns Promise<number>
Inherited from Commander.pfcount
- Defined in utils/RedisCommander.ts:7459
pfcount(...args: [keys: RedisKey[]]): Promise<number>
Parameters
- ...args: [keys: RedisKey[]]
Returns Promise<number>
Inherited from Commander.pfcount
- Defined in utils/RedisCommander.ts:7460

pfdebug

pfdebug(
    subcommand: string | Buffer,
    key: RedisKey,
    callback?: Callback<unknown>,
): Promise<unknown>
Internal commands for debugging HyperLogLog values.
- group: hyperloglog
- complexity: N/A
- since: 2.8.9
Parameters
- subcommand: string | Buffer
- key: RedisKey
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.pfdebug
- Defined in utils/RedisCommander.ts:7468

pfmerge

pfmerge(destkey: RedisKey, callback?: Callback<"OK">): Promise<"OK">
Merges one or more HyperLogLog values into a single key.
- group: hyperloglog
- complexity: O(N) to merge N HyperLogLogs, but with high constant times.
- since: 2.8.9
Parameters
- destkey: RedisKey
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.pfmerge
- Defined in utils/RedisCommander.ts:7480
pfmerge(
    ...args: [
        destkey: RedisKey,
        ...sourcekeys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [destkey: RedisKey, ...sourcekeys: RedisKey[], callback: Callback<"OK">]
Returns Promise<"OK">
Inherited from Commander.pfmerge
- Defined in utils/RedisCommander.ts:7481
pfmerge(
    ...args: [
        destkey: RedisKey,
        sourcekeys: RedisKey[],
        callback: Callback<"OK">,
    ],
): Promise<"OK">
Parameters
- ...args: [destkey: RedisKey, sourcekeys: RedisKey[], callback: Callback<"OK">]
Returns Promise<"OK">
Inherited from Commander.pfmerge
- Defined in utils/RedisCommander.ts:7488
pfmerge(...args: [destkey: RedisKey, ...sourcekeys: RedisKey[]]): Promise<"OK">
Parameters
- ...args: [destkey: RedisKey, ...sourcekeys: RedisKey[]]
Returns Promise<"OK">
Inherited from Commander.pfmerge
- Defined in utils/RedisCommander.ts:7495
pfmerge(...args: [destkey: RedisKey, sourcekeys: RedisKey[]]): Promise<"OK">
Parameters
- ...args: [destkey: RedisKey, sourcekeys: RedisKey[]]
Returns Promise<"OK">
Inherited from Commander.pfmerge
- Defined in utils/RedisCommander.ts:7498

pfselftest

pfselftest(callback?: Callback<unknown>): Promise<unknown>
An internal command for testing HyperLogLog values.
- group: hyperloglog
- complexity: N/A
- since: 2.8.9
Parameters
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.pfselftest
- Defined in utils/RedisCommander.ts:7508

ping

ping(callback?: Callback<"PONG">): Promise<"PONG">
Returns the server's liveliness response.
- group: connection
- complexity: O(1)
- since: 1.0.0
Parameters
- Optionalcallback: Callback<"PONG">
Returns Promise<"PONG">
Inherited from Commander.ping
- Defined in utils/RedisCommander.ts:7516
ping(message: string | Buffer, callback?: Callback<string>): Promise<string>
Parameters
- message: string | Buffer
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.ping
- Defined in utils/RedisCommander.ts:7517

pingBuffer

pingBuffer(
message: string | Buffer,
callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- message: string | Buffer
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.pingBuffer
- Defined in utils/RedisCommander.ts:7521

pipeline

pipeline(commands?: unknown[][]): ChainableCommander
Parameters
- Optionalcommands: unknown[][]
Returns ChainableCommander
- Defined in transaction.ts:8

psetex

psetex(
    key: RedisKey,
    milliseconds: string | number,
    value: string | number | Buffer,
    callback?: Callback<unknown>,
): Promise<unknown>
Sets both string value and expiration time in milliseconds of a key. The key is created if it doesn't exist.
- group: string
- complexity: O(1)
- since: 2.6.0
Parameters
- key: RedisKey
- milliseconds: string | number
- value: string | number | Buffer
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.psetex
- Defined in utils/RedisCommander.ts:7532

psubscribe

psubscribe(
...args: [...patterns: string[], callback: Callback<unknown>],
): Promise<unknown>
Listens for messages published to channels that match one or more patterns.
- group: pubsub
- complexity: O(N) where N is the number of patterns to subscribe to.
- since: 2.0.0
Parameters
- ...args: [...patterns: string[], callback: Callback<unknown>]
Returns Promise<unknown>
Inherited from Commander.psubscribe
- Defined in utils/RedisCommander.ts:7545
psubscribe(...args: string[]): Promise<unknown>
Parameters
- ...args: string[]
Returns Promise<unknown>
Inherited from Commander.psubscribe
- Defined in utils/RedisCommander.ts:7548

psync

psync(
    replicationid: string | number | Buffer,
    offset: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
An internal command used in replication.
- group: server
- complexity: undefined
- since: 2.8.0
Parameters
- replicationid: string | number | Buffer
- offset: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.psync
- Defined in utils/RedisCommander.ts:7556

pttl

pttl(key: RedisKey, callback?: Callback<number>): Promise<number>
Returns the expiration time in milliseconds of a key.
- group: generic
- complexity: O(1)
- since: 2.6.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.pttl
- Defined in utils/RedisCommander.ts:7568

publish

publish(
    channel: string | Buffer,
    message: string | Buffer,
    callback?: Callback<number>,
): Promise<number>
Posts a message to a channel.
- group: pubsub
- complexity: O(N+M) where N is the number of clients subscribed to the receiving channel and M is the total number of subscribed patterns (by any client).
- since: 2.0.0
Parameters
- channel: string | Buffer
- message: string | Buffer
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.publish
- Defined in utils/RedisCommander.ts:7576

pubsub

pubsub(
subcommand: "CHANNELS",
callback?: Callback<unknown[]>,
): Promise<unknown[]>
Returns the active channels.
- group: pubsub
- complexity: O(N) where N is the number of active channels, and assuming constant time pattern matching (relatively short channels and patterns)
- since: 2.8.0
Parameters
- subcommand: "CHANNELS"
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.pubsub
- Defined in utils/RedisCommander.ts:7588
pubsub(
    subcommand: "CHANNELS",
    pattern: string,
    callback?: Callback<unknown[]>,
): Promise<unknown[]>
Parameters
- subcommand: "CHANNELS"
- pattern: string
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.pubsub
- Defined in utils/RedisCommander.ts:7592
pubsub(subcommand: "HELP", callback?: Callback<unknown[]>): Promise<unknown[]>
Returns helpful text about the different subcommands.
- group: pubsub
- complexity: O(1)
- since: 6.2.0
Parameters
- subcommand: "HELP"
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.pubsub
- Defined in utils/RedisCommander.ts:7604
pubsub(subcommand: "NUMPAT", callback?: Callback<unknown[]>): Promise<unknown[]>
Returns a count of unique pattern subscriptions.
- group: pubsub
- complexity: O(1)
- since: 2.8.0
Parameters
- subcommand: "NUMPAT"
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.pubsub
- Defined in utils/RedisCommander.ts:7615
pubsub(subcommand: "NUMSUB", callback?: Callback<unknown[]>): Promise<unknown[]>
Returns a count of subscribers to channels.
- group: pubsub
- complexity: O(N) for the NUMSUB subcommand, where N is the number of requested channels
- since: 2.8.0
Parameters
- subcommand: "NUMSUB"
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.pubsub
- Defined in utils/RedisCommander.ts:7626
pubsub(
    ...args: [
        subcommand: "NUMSUB",
        ...channels: (string | Buffer)[],
        callback: Callback<unknown[]>,
    ],
): Promise<unknown[]>
Parameters
- ...args: [
      subcommand: "NUMSUB",
      ...channels: (string | Buffer)[],
      callback: Callback<unknown[]>,
  ]
Returns Promise<unknown[]>
Inherited from Commander.pubsub
- Defined in utils/RedisCommander.ts:7630
pubsub(
...args: [subcommand: "NUMSUB", ...channels: (string | Buffer)[]],
): Promise<unknown[]>
Parameters
- ...args: [subcommand: "NUMSUB", ...channels: (string | Buffer)[]]
Returns Promise<unknown[]>
Inherited from Commander.pubsub
- Defined in utils/RedisCommander.ts:7637
pubsub(
subcommand: "SHARDCHANNELS",
callback?: Callback<unknown[]>,
): Promise<unknown[]>
Returns the active shard channels.
- group: pubsub
- complexity: O(N) where N is the number of active shard channels, and assuming constant time pattern matching (relatively short shard channels).
- since: 7.0.0
Parameters
- subcommand: "SHARDCHANNELS"
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.pubsub
- Defined in utils/RedisCommander.ts:7647
pubsub(
    subcommand: "SHARDCHANNELS",
    pattern: string,
    callback?: Callback<unknown[]>,
): Promise<unknown[]>
Parameters
- subcommand: "SHARDCHANNELS"
- pattern: string
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.pubsub
- Defined in utils/RedisCommander.ts:7651
pubsub(
subcommand: "SHARDNUMSUB",
callback?: Callback<unknown[]>,
): Promise<unknown[]>
Returns the count of subscribers of shard channels.
- group: pubsub
- complexity: O(N) for the SHARDNUMSUB subcommand, where N is the number of requested shard channels
- since: 7.0.0
Parameters
- subcommand: "SHARDNUMSUB"
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.pubsub
- Defined in utils/RedisCommander.ts:7663
pubsub(
    ...args: [
        subcommand: "SHARDNUMSUB",
        ...shardchannels: (string | Buffer)[],
        callback: Callback<unknown[]>,
    ],
): Promise<unknown[]>
Parameters
- ...args: [
      subcommand: "SHARDNUMSUB",
      ...shardchannels: (string | Buffer)[],
      callback: Callback<unknown[]>,
  ]
Returns Promise<unknown[]>
Inherited from Commander.pubsub
- Defined in utils/RedisCommander.ts:7667
pubsub(
    ...args: [
        subcommand: "SHARDNUMSUB",
        ...shardchannels: (string | Buffer)[],
    ],
): Promise<unknown[]>
Parameters
- ...args: [subcommand: "SHARDNUMSUB", ...shardchannels: (string | Buffer)[]]
Returns Promise<unknown[]>
Inherited from Commander.pubsub
- Defined in utils/RedisCommander.ts:7674

punsubscribe

punsubscribe(callback?: Callback<unknown>): Promise<unknown>
Stops listening to messages published to channels that match one or more patterns.
- group: pubsub
- complexity: O(N) where N is the number of patterns to unsubscribe.
- since: 2.0.0
Parameters
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.punsubscribe
- Defined in utils/RedisCommander.ts:7684
punsubscribe(
...args: [...patterns: string[], callback: Callback<unknown>],
): Promise<unknown>
Parameters
- ...args: [...patterns: string[], callback: Callback<unknown>]
Returns Promise<unknown>
Inherited from Commander.punsubscribe
- Defined in utils/RedisCommander.ts:7685
punsubscribe(...args: string[]): Promise<unknown>
Parameters
- ...args: string[]
Returns Promise<unknown>
Inherited from Commander.punsubscribe
- Defined in utils/RedisCommander.ts:7688

quit

quit(callback?: Callback<"OK">): Promise<"OK">
Quit the cluster gracefully.
Parameters
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Overrides Commander.quit
- Defined in cluster/index.ts:312

randomkey

randomkey(callback?: Callback<string>): Promise<string>
Returns a random key name from the database.
- group: generic
- complexity: O(1)
- since: 1.0.0
Parameters
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.randomkey
- Defined in utils/RedisCommander.ts:7704

randomkeyBuffer

randomkeyBuffer(callback?: Callback<Buffer>): Promise<Buffer>
Parameters
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.randomkeyBuffer
- Defined in utils/RedisCommander.ts:7705

readonly

readonly(callback?: Callback<"OK">): Promise<"OK">
Enables read-only queries for a connection to a Valkey replica node.
- group: cluster
- complexity: O(1)
- since: 3.0.0
Parameters
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.readonly
- Defined in utils/RedisCommander.ts:7715

readwrite

readwrite(callback?: Callback<"OK">): Promise<"OK">
Enables read-write queries for a connection to a Valkey replica node.
- group: cluster
- complexity: O(1)
- since: 3.0.0
Parameters
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.readwrite
- Defined in utils/RedisCommander.ts:7723

rename

rename(
    key: RedisKey,
    newkey: RedisKey,
    callback?: Callback<"OK">,
): Promise<"OK">
Renames a key and overwrites the destination.
- group: generic
- complexity: O(1)
- since: 1.0.0
Parameters
- key: RedisKey
- newkey: RedisKey
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.rename
- Defined in utils/RedisCommander.ts:7731

renamenx

renamenx(
    key: RedisKey,
    newkey: RedisKey,
    callback?: Callback<number>,
): Promise<number>
Renames a key only when the target key name doesn't exist.
- group: generic
- complexity: O(1)
- since: 1.0.0
Parameters
- key: RedisKey
- newkey: RedisKey
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.renamenx
- Defined in utils/RedisCommander.ts:7743

replconf

replconf(callback?: Callback<unknown>): Promise<unknown>
An internal command for configuring the replication stream.
- group: server
- complexity: O(1)
- since: 3.0.0
Parameters
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.replconf
- Defined in utils/RedisCommander.ts:7755

replicaof

replicaof(
    host: string | Buffer,
    port: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Configures a server as replica of another, or promotes it to a primary.
- group: server
- complexity: O(1)
- since: 5.0.0
Parameters
- host: string | Buffer
- port: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.replicaof
- Defined in utils/RedisCommander.ts:7763
replicaof(no: "NO", one: "ONE", callback?: Callback<"OK">): Promise<"OK">
Parameters
- no: "NO"
- one: "ONE"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.replicaof
- Defined in utils/RedisCommander.ts:7768

reset

reset(callback?: Callback<"OK">): Promise<"OK">
Resets the connection.
- group: connection
- complexity: O(1)
- since: 6.2.0
Parameters
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.reset
- Defined in utils/RedisCommander.ts:7780

restore

restore(
    key: RedisKey,
    ttl: string | number,
    serializedValue: string | number | Buffer,
    callback?: Callback<"OK">,
): Promise<"OK">
Creates a key from the serialized representation of a value.
- group: generic
- complexity: O(1) to create the new key and additional O(NM) to reconstruct the serialized value, where N is the number of objects composing the value and M their average size. For small string values the time complexity is thus O(1)+O(1M) where M is small, so simply O(1). However for sorted set values the complexity is O(NMlog(N)) because inserting values into sorted sets is O(log(N)).
- since: 2.6.0
Parameters
- key: RedisKey
- ttl: string | number
- serializedValue: string | number | Buffer
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.restore
- Defined in utils/RedisCommander.ts:7788
restore(
    key: RedisKey,
    ttl: string | number,
    serializedValue: string | number | Buffer,
    frequencyToken: "FREQ",
    frequency: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- ttl: string | number
- serializedValue: string | number | Buffer
- frequencyToken: "FREQ"
- frequency: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.restore
- Defined in utils/RedisCommander.ts:7794
restore(
    key: RedisKey,
    ttl: string | number,
    serializedValue: string | number | Buffer,
    secondsToken: "IDLETIME",
    seconds: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- ttl: string | number
- serializedValue: string | number | Buffer
- secondsToken: "IDLETIME"
- seconds: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.restore
- Defined in utils/RedisCommander.ts:7802
restore(
    key: RedisKey,
    ttl: string | number,
    serializedValue: string | number | Buffer,
    secondsToken: "IDLETIME",
    seconds: string | number,
    frequencyToken: "FREQ",
    frequency: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- ttl: string | number
- serializedValue: string | number | Buffer
- secondsToken: "IDLETIME"
- seconds: string | number
- frequencyToken: "FREQ"
- frequency: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.restore
- Defined in utils/RedisCommander.ts:7810
restore(
    key: RedisKey,
    ttl: string | number,
    serializedValue: string | number | Buffer,
    absttl: "ABSTTL",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- ttl: string | number
- serializedValue: string | number | Buffer
- absttl: "ABSTTL"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.restore
- Defined in utils/RedisCommander.ts:7820
restore(
    key: RedisKey,
    ttl: string | number,
    serializedValue: string | number | Buffer,
    absttl: "ABSTTL",
    frequencyToken: "FREQ",
    frequency: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- ttl: string | number
- serializedValue: string | number | Buffer
- absttl: "ABSTTL"
- frequencyToken: "FREQ"
- frequency: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.restore
- Defined in utils/RedisCommander.ts:7827
restore(
    key: RedisKey,
    ttl: string | number,
    serializedValue: string | number | Buffer,
    absttl: "ABSTTL",
    secondsToken: "IDLETIME",
    seconds: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- ttl: string | number
- serializedValue: string | number | Buffer
- absttl: "ABSTTL"
- secondsToken: "IDLETIME"
- seconds: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.restore
- Defined in utils/RedisCommander.ts:7836
restore(
    key: RedisKey,
    ttl: string | number,
    serializedValue: string | number | Buffer,
    absttl: "ABSTTL",
    secondsToken: "IDLETIME",
    seconds: string | number,
    frequencyToken: "FREQ",
    frequency: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- ttl: string | number
- serializedValue: string | number | Buffer
- absttl: "ABSTTL"
- secondsToken: "IDLETIME"
- seconds: string | number
- frequencyToken: "FREQ"
- frequency: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.restore
- Defined in utils/RedisCommander.ts:7845
restore(
    key: RedisKey,
    ttl: string | number,
    serializedValue: string | number | Buffer,
    replace: "REPLACE",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- ttl: string | number
- serializedValue: string | number | Buffer
- replace: "REPLACE"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.restore
- Defined in utils/RedisCommander.ts:7856
restore(
    key: RedisKey,
    ttl: string | number,
    serializedValue: string | number | Buffer,
    replace: "REPLACE",
    frequencyToken: "FREQ",
    frequency: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- ttl: string | number
- serializedValue: string | number | Buffer
- replace: "REPLACE"
- frequencyToken: "FREQ"
- frequency: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.restore
- Defined in utils/RedisCommander.ts:7863
restore(
    key: RedisKey,
    ttl: string | number,
    serializedValue: string | number | Buffer,
    replace: "REPLACE",
    secondsToken: "IDLETIME",
    seconds: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- ttl: string | number
- serializedValue: string | number | Buffer
- replace: "REPLACE"
- secondsToken: "IDLETIME"
- seconds: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.restore
- Defined in utils/RedisCommander.ts:7872
restore(
    key: RedisKey,
    ttl: string | number,
    serializedValue: string | number | Buffer,
    replace: "REPLACE",
    secondsToken: "IDLETIME",
    seconds: string | number,
    frequencyToken: "FREQ",
    frequency: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- ttl: string | number
- serializedValue: string | number | Buffer
- replace: "REPLACE"
- secondsToken: "IDLETIME"
- seconds: string | number
- frequencyToken: "FREQ"
- frequency: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.restore
- Defined in utils/RedisCommander.ts:7881
restore(
    key: RedisKey,
    ttl: string | number,
    serializedValue: string | number | Buffer,
    replace: "REPLACE",
    absttl: "ABSTTL",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- ttl: string | number
- serializedValue: string | number | Buffer
- replace: "REPLACE"
- absttl: "ABSTTL"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.restore
- Defined in utils/RedisCommander.ts:7892
restore(
    key: RedisKey,
    ttl: string | number,
    serializedValue: string | number | Buffer,
    replace: "REPLACE",
    absttl: "ABSTTL",
    frequencyToken: "FREQ",
    frequency: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- ttl: string | number
- serializedValue: string | number | Buffer
- replace: "REPLACE"
- absttl: "ABSTTL"
- frequencyToken: "FREQ"
- frequency: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.restore
- Defined in utils/RedisCommander.ts:7900
restore(
    key: RedisKey,
    ttl: string | number,
    serializedValue: string | number | Buffer,
    replace: "REPLACE",
    absttl: "ABSTTL",
    secondsToken: "IDLETIME",
    seconds: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- ttl: string | number
- serializedValue: string | number | Buffer
- replace: "REPLACE"
- absttl: "ABSTTL"
- secondsToken: "IDLETIME"
- seconds: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.restore
- Defined in utils/RedisCommander.ts:7910
restore(
    key: RedisKey,
    ttl: string | number,
    serializedValue: string | number | Buffer,
    replace: "REPLACE",
    absttl: "ABSTTL",
    secondsToken: "IDLETIME",
    seconds: string | number,
    frequencyToken: "FREQ",
    frequency: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- ttl: string | number
- serializedValue: string | number | Buffer
- replace: "REPLACE"
- absttl: "ABSTTL"
- secondsToken: "IDLETIME"
- seconds: string | number
- frequencyToken: "FREQ"
- frequency: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.restore
- Defined in utils/RedisCommander.ts:7920

restore-asking

"restore-asking"(
    key: RedisKey,
    ttl: string | number,
    serializedValue: string | number | Buffer,
    callback?: Callback<unknown>,
): Promise<unknown>
An internal command for migrating keys in a cluster.
- group: server
- complexity: O(1) to create the new key and additional O(NM) to reconstruct the serialized value, where N is the number of objects composing the value and M their average size. For small string values the time complexity is thus O(1)+O(1M) where M is small, so simply O(1). However for sorted set values the complexity is O(NMlog(N)) because inserting values into sorted sets is O(log(N)).
- since: 3.0.0
Parameters
- key: RedisKey
- ttl: string | number
- serializedValue: string | number | Buffer
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.restore-asking
- Defined in utils/RedisCommander.ts:7939
"restore-asking"(
    key: RedisKey,
    ttl: string | number,
    serializedValue: string | number | Buffer,
    frequencyToken: "FREQ",
    frequency: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- ttl: string | number
- serializedValue: string | number | Buffer
- frequencyToken: "FREQ"
- frequency: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.restore-asking
- Defined in utils/RedisCommander.ts:7945
"restore-asking"(
    key: RedisKey,
    ttl: string | number,
    serializedValue: string | number | Buffer,
    secondsToken: "IDLETIME",
    seconds: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- ttl: string | number
- serializedValue: string | number | Buffer
- secondsToken: "IDLETIME"
- seconds: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.restore-asking
- Defined in utils/RedisCommander.ts:7953
"restore-asking"(
    key: RedisKey,
    ttl: string | number,
    serializedValue: string | number | Buffer,
    secondsToken: "IDLETIME",
    seconds: string | number,
    frequencyToken: "FREQ",
    frequency: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- ttl: string | number
- serializedValue: string | number | Buffer
- secondsToken: "IDLETIME"
- seconds: string | number
- frequencyToken: "FREQ"
- frequency: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.restore-asking
- Defined in utils/RedisCommander.ts:7961
"restore-asking"(
    key: RedisKey,
    ttl: string | number,
    serializedValue: string | number | Buffer,
    absttl: "ABSTTL",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- ttl: string | number
- serializedValue: string | number | Buffer
- absttl: "ABSTTL"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.restore-asking
- Defined in utils/RedisCommander.ts:7971
"restore-asking"(
    key: RedisKey,
    ttl: string | number,
    serializedValue: string | number | Buffer,
    absttl: "ABSTTL",
    frequencyToken: "FREQ",
    frequency: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- ttl: string | number
- serializedValue: string | number | Buffer
- absttl: "ABSTTL"
- frequencyToken: "FREQ"
- frequency: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.restore-asking
- Defined in utils/RedisCommander.ts:7978
"restore-asking"(
    key: RedisKey,
    ttl: string | number,
    serializedValue: string | number | Buffer,
    absttl: "ABSTTL",
    secondsToken: "IDLETIME",
    seconds: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- ttl: string | number
- serializedValue: string | number | Buffer
- absttl: "ABSTTL"
- secondsToken: "IDLETIME"
- seconds: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.restore-asking
- Defined in utils/RedisCommander.ts:7987
"restore-asking"(
    key: RedisKey,
    ttl: string | number,
    serializedValue: string | number | Buffer,
    absttl: "ABSTTL",
    secondsToken: "IDLETIME",
    seconds: string | number,
    frequencyToken: "FREQ",
    frequency: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- ttl: string | number
- serializedValue: string | number | Buffer
- absttl: "ABSTTL"
- secondsToken: "IDLETIME"
- seconds: string | number
- frequencyToken: "FREQ"
- frequency: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.restore-asking
- Defined in utils/RedisCommander.ts:7996
"restore-asking"(
    key: RedisKey,
    ttl: string | number,
    serializedValue: string | number | Buffer,
    replace: "REPLACE",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- ttl: string | number
- serializedValue: string | number | Buffer
- replace: "REPLACE"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.restore-asking
- Defined in utils/RedisCommander.ts:8007
"restore-asking"(
    key: RedisKey,
    ttl: string | number,
    serializedValue: string | number | Buffer,
    replace: "REPLACE",
    frequencyToken: "FREQ",
    frequency: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- ttl: string | number
- serializedValue: string | number | Buffer
- replace: "REPLACE"
- frequencyToken: "FREQ"
- frequency: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.restore-asking
- Defined in utils/RedisCommander.ts:8014
"restore-asking"(
    key: RedisKey,
    ttl: string | number,
    serializedValue: string | number | Buffer,
    replace: "REPLACE",
    secondsToken: "IDLETIME",
    seconds: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- ttl: string | number
- serializedValue: string | number | Buffer
- replace: "REPLACE"
- secondsToken: "IDLETIME"
- seconds: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.restore-asking
- Defined in utils/RedisCommander.ts:8023
"restore-asking"(
    key: RedisKey,
    ttl: string | number,
    serializedValue: string | number | Buffer,
    replace: "REPLACE",
    secondsToken: "IDLETIME",
    seconds: string | number,
    frequencyToken: "FREQ",
    frequency: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- ttl: string | number
- serializedValue: string | number | Buffer
- replace: "REPLACE"
- secondsToken: "IDLETIME"
- seconds: string | number
- frequencyToken: "FREQ"
- frequency: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.restore-asking
- Defined in utils/RedisCommander.ts:8032
"restore-asking"(
    key: RedisKey,
    ttl: string | number,
    serializedValue: string | number | Buffer,
    replace: "REPLACE",
    absttl: "ABSTTL",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- ttl: string | number
- serializedValue: string | number | Buffer
- replace: "REPLACE"
- absttl: "ABSTTL"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.restore-asking
- Defined in utils/RedisCommander.ts:8043
"restore-asking"(
    key: RedisKey,
    ttl: string | number,
    serializedValue: string | number | Buffer,
    replace: "REPLACE",
    absttl: "ABSTTL",
    frequencyToken: "FREQ",
    frequency: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- ttl: string | number
- serializedValue: string | number | Buffer
- replace: "REPLACE"
- absttl: "ABSTTL"
- frequencyToken: "FREQ"
- frequency: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.restore-asking
- Defined in utils/RedisCommander.ts:8051
"restore-asking"(
    key: RedisKey,
    ttl: string | number,
    serializedValue: string | number | Buffer,
    replace: "REPLACE",
    absttl: "ABSTTL",
    secondsToken: "IDLETIME",
    seconds: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- ttl: string | number
- serializedValue: string | number | Buffer
- replace: "REPLACE"
- absttl: "ABSTTL"
- secondsToken: "IDLETIME"
- seconds: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.restore-asking
- Defined in utils/RedisCommander.ts:8061
"restore-asking"(
    key: RedisKey,
    ttl: string | number,
    serializedValue: string | number | Buffer,
    replace: "REPLACE",
    absttl: "ABSTTL",
    secondsToken: "IDLETIME",
    seconds: string | number,
    frequencyToken: "FREQ",
    frequency: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- ttl: string | number
- serializedValue: string | number | Buffer
- replace: "REPLACE"
- absttl: "ABSTTL"
- secondsToken: "IDLETIME"
- seconds: string | number
- frequencyToken: "FREQ"
- frequency: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.restore-asking
- Defined in utils/RedisCommander.ts:8071

role

role(callback?: Callback<unknown[]>): Promise<unknown[]>
Returns the replication role.
- group: server
- complexity: O(1)
- since: 2.8.12
Parameters
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.role
- Defined in utils/RedisCommander.ts:8090

rpop

rpop(key: RedisKey, callback?: Callback<string>): Promise<string>
Returns and removes the last elements of a list. Deletes the list if the last element was popped.
- group: list
- complexity: O(N) where N is the number of elements returned
- since: 1.0.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.rpop
- Defined in utils/RedisCommander.ts:8098
rpop(
    key: RedisKey,
    count: string | number,
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- count: string | number
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.rpop
- Defined in utils/RedisCommander.ts:8106

rpopBuffer

rpopBuffer(key: RedisKey, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
- key: RedisKey
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.rpopBuffer
- Defined in utils/RedisCommander.ts:8102
rpopBuffer(
    key: RedisKey,
    count: string | number,
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- count: string | number
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.rpopBuffer
- Defined in utils/RedisCommander.ts:8111

rpoplpush

rpoplpush(
    source: RedisKey,
    destination: RedisKey,
    callback?: Callback<string>,
): Promise<string>
Returns the last element of a list after removing and pushing it to another list. Deletes the list if the last element was popped.
- group: list
- complexity: O(1)
- since: 1.2.0
Parameters
- source: RedisKey
- destination: RedisKey
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.rpoplpush
- Defined in utils/RedisCommander.ts:8123

rpoplpushBuffer

rpoplpushBuffer(
    source: RedisKey,
    destination: RedisKey,
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- source: RedisKey
- destination: RedisKey
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.rpoplpushBuffer
- Defined in utils/RedisCommander.ts:8128

rpush

rpush(
    ...args: [
        key: RedisKey,
        ...elements: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Appends one or more elements to a list. Creates the key if it doesn't exist.
- group: list
- complexity: O(1) for each element added, so O(N) to add N elements when the command is called with multiple arguments.
- since: 1.0.0
Parameters
- ...args: [
      key: RedisKey,
      ...elements: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.rpush
- Defined in utils/RedisCommander.ts:8140
rpush(
...args: [key: RedisKey, ...elements: (string | number | Buffer)[]],
): Promise<number>
Parameters
- ...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.rpush
- Defined in utils/RedisCommander.ts:8147

rpushx

rpushx(
    ...args: [
        key: RedisKey,
        ...elements: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Appends an element to a list only when the list exists.
- group: list
- complexity: O(1) for each element added, so O(N) to add N elements when the command is called with multiple arguments.
- since: 2.2.0
Parameters
- ...args: [
      key: RedisKey,
      ...elements: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.rpushx
- Defined in utils/RedisCommander.ts:8157
rpushx(
...args: [key: RedisKey, ...elements: (string | number | Buffer)[]],
): Promise<number>
Parameters
- ...args: [key: RedisKey, ...elements: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.rpushx
- Defined in utils/RedisCommander.ts:8164

sadd

sadd(
    ...args: [
        key: RedisKey,
        ...members: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Adds one or more members to a set. Creates the key if it doesn't exist.
- group: set
- complexity: O(1) for each element added, so O(N) to add N elements when the command is called with multiple arguments.
- since: 1.0.0
Parameters
- ...args: [
      key: RedisKey,
      ...members: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.sadd
- Defined in utils/RedisCommander.ts:8174
sadd(
    ...args: [
        key: RedisKey,
        members: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      key: RedisKey,
      members: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.sadd
- Defined in utils/RedisCommander.ts:8181
sadd(
...args: [key: RedisKey, ...members: (string | number | Buffer)[]],
): Promise<number>
Parameters
- ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.sadd
- Defined in utils/RedisCommander.ts:8188
sadd(
...args: [key: RedisKey, members: (string | number | Buffer)[]],
): Promise<number>
Parameters
- ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.sadd
- Defined in utils/RedisCommander.ts:8191

save

save(callback?: Callback<"OK">): Promise<"OK">
Synchronously saves the database(s) to disk.
- group: server
- complexity: O(N) where N is the total number of keys in all databases
- since: 1.0.0
Parameters
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.save
- Defined in utils/RedisCommander.ts:8201

scan

scan(
cursor: string | number,
callback?: Callback<[cursor: string, elements: string[]]>,
): Promise<[cursor: string, elements: string[]]>
Iterates over the key names in the database.
- group: generic
- complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection.
- since: 2.8.0
Parameters
- cursor: string | number
- Optionalcallback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Inherited from Commander.scan
- Defined in utils/RedisCommander.ts:8209
scan(
    cursor: string | number,
    typeToken: "TYPE",
    type: string | Buffer,
    callback?: Callback<[cursor: string, elements: string[]]>,
): Promise<[cursor: string, elements: string[]]>
Parameters
- cursor: string | number
- typeToken: "TYPE"
- type: string | Buffer
- Optionalcallback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Inherited from Commander.scan
- Defined in utils/RedisCommander.ts:8217
scan(
    cursor: string | number,
    countToken: "COUNT",
    count: string | number,
    callback?: Callback<[cursor: string, elements: string[]]>,
): Promise<[cursor: string, elements: string[]]>
Parameters
- cursor: string | number
- countToken: "COUNT"
- count: string | number
- Optionalcallback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Inherited from Commander.scan
- Defined in utils/RedisCommander.ts:8229
scan(
    cursor: string | number,
    countToken: "COUNT",
    count: string | number,
    typeToken: "TYPE",
    type: string | Buffer,
    callback?: Callback<[cursor: string, elements: string[]]>,
): Promise<[cursor: string, elements: string[]]>
Parameters
- cursor: string | number
- countToken: "COUNT"
- count: string | number
- typeToken: "TYPE"
- type: string | Buffer
- Optionalcallback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Inherited from Commander.scan
- Defined in utils/RedisCommander.ts:8241
scan(
    cursor: string | number,
    patternToken: "MATCH",
    pattern: string,
    callback?: Callback<[cursor: string, elements: string[]]>,
): Promise<[cursor: string, elements: string[]]>
Parameters
- cursor: string | number
- patternToken: "MATCH"
- pattern: string
- Optionalcallback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Inherited from Commander.scan
- Defined in utils/RedisCommander.ts:8257
scan(
    cursor: string | number,
    patternToken: "MATCH",
    pattern: string,
    typeToken: "TYPE",
    type: string | Buffer,
    callback?: Callback<[cursor: string, elements: string[]]>,
): Promise<[cursor: string, elements: string[]]>
Parameters
- cursor: string | number
- patternToken: "MATCH"
- pattern: string
- typeToken: "TYPE"
- type: string | Buffer
- Optionalcallback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Inherited from Commander.scan
- Defined in utils/RedisCommander.ts:8269
scan(
    cursor: string | number,
    patternToken: "MATCH",
    pattern: string,
    countToken: "COUNT",
    count: string | number,
    callback?: Callback<[cursor: string, elements: string[]]>,
): Promise<[cursor: string, elements: string[]]>
Parameters
- cursor: string | number
- patternToken: "MATCH"
- pattern: string
- countToken: "COUNT"
- count: string | number
- Optionalcallback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Inherited from Commander.scan
- Defined in utils/RedisCommander.ts:8285
scan(
    cursor: string | number,
    patternToken: "MATCH",
    pattern: string,
    countToken: "COUNT",
    count: string | number,
    typeToken: "TYPE",
    type: string | Buffer,
    callback?: Callback<[cursor: string, elements: string[]]>,
): Promise<[cursor: string, elements: string[]]>
Parameters
- cursor: string | number
- patternToken: "MATCH"
- pattern: string
- countToken: "COUNT"
- count: string | number
- typeToken: "TYPE"
- type: string | Buffer
- Optionalcallback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Inherited from Commander.scan
- Defined in utils/RedisCommander.ts:8301

scanBuffer

scanBuffer(
cursor: string | number,
callback?: Callback<[cursor: Buffer, elements: Buffer[]]>,
): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
- cursor: string | number
- Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Inherited from Commander.scanBuffer
- Defined in utils/RedisCommander.ts:8213
scanBuffer(
    cursor: string | number,
    typeToken: "TYPE",
    type: string | Buffer,
    callback?: Callback<[cursor: Buffer, elements: Buffer[]]>,
): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
- cursor: string | number
- typeToken: "TYPE"
- type: string | Buffer
- Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Inherited from Commander.scanBuffer
- Defined in utils/RedisCommander.ts:8223
scanBuffer(
    cursor: string | number,
    countToken: "COUNT",
    count: string | number,
    callback?: Callback<[cursor: Buffer, elements: Buffer[]]>,
): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
- cursor: string | number
- countToken: "COUNT"
- count: string | number
- Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Inherited from Commander.scanBuffer
- Defined in utils/RedisCommander.ts:8235
scanBuffer(
    cursor: string | number,
    countToken: "COUNT",
    count: string | number,
    typeToken: "TYPE",
    type: string | Buffer,
    callback?: Callback<[cursor: Buffer, elements: Buffer[]]>,
): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
- cursor: string | number
- countToken: "COUNT"
- count: string | number
- typeToken: "TYPE"
- type: string | Buffer
- Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Inherited from Commander.scanBuffer
- Defined in utils/RedisCommander.ts:8249
scanBuffer(
    cursor: string | number,
    patternToken: "MATCH",
    pattern: string,
    callback?: Callback<[cursor: Buffer, elements: Buffer[]]>,
): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
- cursor: string | number
- patternToken: "MATCH"
- pattern: string
- Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Inherited from Commander.scanBuffer
- Defined in utils/RedisCommander.ts:8263
scanBuffer(
    cursor: string | number,
    patternToken: "MATCH",
    pattern: string,
    typeToken: "TYPE",
    type: string | Buffer,
    callback?: Callback<[cursor: Buffer, elements: Buffer[]]>,
): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
- cursor: string | number
- patternToken: "MATCH"
- pattern: string
- typeToken: "TYPE"
- type: string | Buffer
- Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Inherited from Commander.scanBuffer
- Defined in utils/RedisCommander.ts:8277
scanBuffer(
    cursor: string | number,
    patternToken: "MATCH",
    pattern: string,
    countToken: "COUNT",
    count: string | number,
    callback?: Callback<[cursor: Buffer, elements: Buffer[]]>,
): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
- cursor: string | number
- patternToken: "MATCH"
- pattern: string
- countToken: "COUNT"
- count: string | number
- Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Inherited from Commander.scanBuffer
- Defined in utils/RedisCommander.ts:8293
scanBuffer(
    cursor: string | number,
    patternToken: "MATCH",
    pattern: string,
    countToken: "COUNT",
    count: string | number,
    typeToken: "TYPE",
    type: string | Buffer,
    callback?: Callback<[cursor: Buffer, elements: Buffer[]]>,
): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
- cursor: string | number
- patternToken: "MATCH"
- pattern: string
- countToken: "COUNT"
- count: string | number
- typeToken: "TYPE"
- type: string | Buffer
- Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Inherited from Commander.scanBuffer
- Defined in utils/RedisCommander.ts:8311

scard

scard(key: RedisKey, callback?: Callback<number>): Promise<number>
Returns the number of members in a set.
- group: set
- complexity: O(1)
- since: 1.0.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.scard
- Defined in utils/RedisCommander.ts:8328

script

script(
    subcommand: "DEBUG",
    yes: "YES",
    callback?: Callback<unknown>,
): Promise<unknown>
Sets the debug mode of server-side Lua scripts.
- group: scripting
- complexity: O(1)
- since: 3.2.0
Parameters
- subcommand: "DEBUG"
- yes: "YES"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.script
- Defined in utils/RedisCommander.ts:8336
script(
    subcommand: "DEBUG",
    sync: "SYNC",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "DEBUG"
- sync: "SYNC"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.script
- Defined in utils/RedisCommander.ts:8341
script(
    subcommand: "DEBUG",
    no: "NO",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "DEBUG"
- no: "NO"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.script
- Defined in utils/RedisCommander.ts:8346
script(
    ...args: [
        subcommand: "EXISTS",
        ...sha1s: (string | Buffer)[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Determines whether server-side Lua scripts exist in the script cache.
- group: scripting
- complexity: O(N) with N being the number of scripts to check (so checking a single script is an O(1) operation).
- since: 2.6.0
Parameters
- ...args: [
      subcommand: "EXISTS",
      ...sha1s: (string | Buffer)[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.script
- Defined in utils/RedisCommander.ts:8358
script(
...args: [subcommand: "EXISTS", ...sha1s: (string | Buffer)[]],
): Promise<unknown>
Parameters
- ...args: [subcommand: "EXISTS", ...sha1s: (string | Buffer)[]]
Returns Promise<unknown>
Inherited from Commander.script
- Defined in utils/RedisCommander.ts:8365
script(subcommand: "FLUSH", callback?: Callback<unknown>): Promise<unknown>
Removes all server-side Lua scripts from the script cache.
- group: scripting
- complexity: O(N) with N being the number of scripts in cache
- since: 2.6.0
Parameters
- subcommand: "FLUSH"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.script
- Defined in utils/RedisCommander.ts:8375
script(
    subcommand: "FLUSH",
    async: "ASYNC",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "FLUSH"
- async: "ASYNC"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.script
- Defined in utils/RedisCommander.ts:8379
script(
    subcommand: "FLUSH",
    sync: "SYNC",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "FLUSH"
- sync: "SYNC"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.script
- Defined in utils/RedisCommander.ts:8384
script(subcommand: "HELP", callback?: Callback<unknown>): Promise<unknown>
Returns helpful text about the different subcommands.
- group: scripting
- complexity: O(1)
- since: 5.0.0
Parameters
- subcommand: "HELP"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.script
- Defined in utils/RedisCommander.ts:8396
script(subcommand: "KILL", callback?: Callback<unknown>): Promise<unknown>
Terminates a server-side Lua script during execution.
- group: scripting
- complexity: O(1)
- since: 2.6.0
Parameters
- subcommand: "KILL"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.script
- Defined in utils/RedisCommander.ts:8407
script(
    subcommand: "LOAD",
    script: string | Buffer,
    callback?: Callback<unknown>,
): Promise<unknown>
Loads a server-side Lua script to the script cache.
- group: scripting
- complexity: O(N) with N being the length in bytes of the script body.
- since: 2.6.0
Parameters
- subcommand: "LOAD"
- script: string | Buffer
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.script
- Defined in utils/RedisCommander.ts:8418
script(
    subcommand: "SHOW",
    sha1: string | Buffer,
    callback?: Callback<unknown>,
): Promise<unknown>
Show server-side Lua script in the script cache.
- group: scripting
- complexity: O(1).
- since: 8.0.0
Parameters
- subcommand: "SHOW"
- sha1: string | Buffer
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.script
- Defined in utils/RedisCommander.ts:8430

sdiff

sdiff(
...args: [...keys: RedisKey[], callback: Callback<string[]>],
): Promise<string[]>
Returns the difference of multiple sets.
- group: set
- complexity: O(N) where N is the total number of elements in all given sets.
- since: 1.0.0
Parameters
- ...args: [...keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Inherited from Commander.sdiff
- Defined in utils/RedisCommander.ts:8442
sdiff(
...args: [keys: RedisKey[], callback: Callback<string[]>],
): Promise<string[]>
Parameters
- ...args: [keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Inherited from Commander.sdiff
- Defined in utils/RedisCommander.ts:8448
sdiff(...args: RedisKey[]): Promise<string[]>
Parameters
- ...args: RedisKey[]
Returns Promise<string[]>
Inherited from Commander.sdiff
- Defined in utils/RedisCommander.ts:8454
sdiff(...args: [keys: RedisKey[]]): Promise<string[]>
Parameters
- ...args: [keys: RedisKey[]]
Returns Promise<string[]>
Inherited from Commander.sdiff
- Defined in utils/RedisCommander.ts:8456

sdiffBuffer

sdiffBuffer(
...args: [...keys: RedisKey[], callback: Callback<Buffer[]>],
): Promise<Buffer[]>
Parameters
- ...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Inherited from Commander.sdiffBuffer
- Defined in utils/RedisCommander.ts:8445
sdiffBuffer(
...args: [keys: RedisKey[], callback: Callback<Buffer[]>],
): Promise<Buffer[]>
Parameters
- ...args: [keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Inherited from Commander.sdiffBuffer
- Defined in utils/RedisCommander.ts:8451
sdiffBuffer(...args: RedisKey[]): Promise<Buffer[]>
Parameters
- ...args: RedisKey[]
Returns Promise<Buffer[]>
Inherited from Commander.sdiffBuffer
- Defined in utils/RedisCommander.ts:8455
sdiffBuffer(...args: [keys: RedisKey[]]): Promise<Buffer[]>
Parameters
- ...args: [keys: RedisKey[]]
Returns Promise<Buffer[]>
Inherited from Commander.sdiffBuffer
- Defined in utils/RedisCommander.ts:8457

sdiffstore

sdiffstore(
    ...args: [
        destination: RedisKey,
        ...keys: RedisKey[],
        callback: Callback<number>,
    ],
): Promise<number>
Stores the difference of multiple sets in a key.
- group: set
- complexity: O(N) where N is the total number of elements in all given sets.
- since: 1.0.0
Parameters
- ...args: [destination: RedisKey, ...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Inherited from Commander.sdiffstore
- Defined in utils/RedisCommander.ts:8465
sdiffstore(
    ...args: [
        destination: RedisKey,
        keys: RedisKey[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [destination: RedisKey, keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Inherited from Commander.sdiffstore
- Defined in utils/RedisCommander.ts:8472
sdiffstore(
...args: [destination: RedisKey, ...keys: RedisKey[]],
): Promise<number>
Parameters
- ...args: [destination: RedisKey, ...keys: RedisKey[]]
Returns Promise<number>
Inherited from Commander.sdiffstore
- Defined in utils/RedisCommander.ts:8479
sdiffstore(...args: [destination: RedisKey, keys: RedisKey[]]): Promise<number>
Parameters
- ...args: [destination: RedisKey, keys: RedisKey[]]
Returns Promise<number>
Inherited from Commander.sdiffstore
- Defined in utils/RedisCommander.ts:8482

select

select(index: string | number, callback?: Callback<"OK">): Promise<"OK">
Changes the selected database.
- group: connection
- complexity: O(1)
- since: 1.0.0
Parameters
- index: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.select
- Defined in utils/RedisCommander.ts:8492

set

set(
    key: RedisKey,
    value: string | number | Buffer,
    callback?: Callback<"OK">,
): Promise<"OK">
Sets the string value of a key, ignoring its type. The key is created if it doesn't exist.
- group: string
- complexity: O(1)
- since: 1.0.0
Parameters
- key: RedisKey
- value: string | number | Buffer
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8503
set(
    key: RedisKey,
    value: string | number | Buffer,
    get: "GET",
    callback?: Callback<string>,
): Promise<string>
Parameters
- key: RedisKey
- value: string | number | Buffer
- get: "GET"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8508
set(
    key: RedisKey,
    value: string | number | Buffer,
    nx: "NX",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- value: string | number | Buffer
- nx: "NX"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8520
set(
    key: RedisKey,
    value: string | number | Buffer,
    nx: "NX",
    get: "GET",
    callback?: Callback<string>,
): Promise<string>
Parameters
- key: RedisKey
- value: string | number | Buffer
- nx: "NX"
- get: "GET"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8526
set(
    key: RedisKey,
    value: string | number | Buffer,
    xx: "XX",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- value: string | number | Buffer
- xx: "XX"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8540
set(
    key: RedisKey,
    value: string | number | Buffer,
    xx: "XX",
    get: "GET",
    callback?: Callback<string>,
): Promise<string>
Parameters
- key: RedisKey
- value: string | number | Buffer
- xx: "XX"
- get: "GET"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8546
set(
    key: RedisKey,
    value: string | number | Buffer,
    secondsToken: "EX",
    seconds: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- value: string | number | Buffer
- secondsToken: "EX"
- seconds: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8560
set(
    key: RedisKey,
    value: string | number | Buffer,
    secondsToken: "EX",
    seconds: string | number,
    get: "GET",
    callback?: Callback<string>,
): Promise<string>
Parameters
- key: RedisKey
- value: string | number | Buffer
- secondsToken: "EX"
- seconds: string | number
- get: "GET"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8567
set(
    key: RedisKey,
    value: string | number | Buffer,
    secondsToken: "EX",
    seconds: string | number,
    nx: "NX",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- value: string | number | Buffer
- secondsToken: "EX"
- seconds: string | number
- nx: "NX"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8583
set(
    key: RedisKey,
    value: string | number | Buffer,
    secondsToken: "EX",
    seconds: string | number,
    nx: "NX",
    get: "GET",
    callback?: Callback<string>,
): Promise<string>
Parameters
- key: RedisKey
- value: string | number | Buffer
- secondsToken: "EX"
- seconds: string | number
- nx: "NX"
- get: "GET"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8591
set(
    key: RedisKey,
    value: string | number | Buffer,
    secondsToken: "EX",
    seconds: string | number,
    xx: "XX",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- value: string | number | Buffer
- secondsToken: "EX"
- seconds: string | number
- xx: "XX"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8609
set(
    key: RedisKey,
    value: string | number | Buffer,
    secondsToken: "EX",
    seconds: string | number,
    xx: "XX",
    get: "GET",
    callback?: Callback<string>,
): Promise<string>
Parameters
- key: RedisKey
- value: string | number | Buffer
- secondsToken: "EX"
- seconds: string | number
- xx: "XX"
- get: "GET"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8617
set(
    key: RedisKey,
    value: string | number | Buffer,
    millisecondsToken: "PX",
    milliseconds: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- value: string | number | Buffer
- millisecondsToken: "PX"
- milliseconds: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8635
set(
    key: RedisKey,
    value: string | number | Buffer,
    millisecondsToken: "PX",
    milliseconds: string | number,
    get: "GET",
    callback?: Callback<string>,
): Promise<string>
Parameters
- key: RedisKey
- value: string | number | Buffer
- millisecondsToken: "PX"
- milliseconds: string | number
- get: "GET"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8642
set(
    key: RedisKey,
    value: string | number | Buffer,
    millisecondsToken: "PX",
    milliseconds: string | number,
    nx: "NX",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- value: string | number | Buffer
- millisecondsToken: "PX"
- milliseconds: string | number
- nx: "NX"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8658
set(
    key: RedisKey,
    value: string | number | Buffer,
    millisecondsToken: "PX",
    milliseconds: string | number,
    nx: "NX",
    get: "GET",
    callback?: Callback<string>,
): Promise<string>
Parameters
- key: RedisKey
- value: string | number | Buffer
- millisecondsToken: "PX"
- milliseconds: string | number
- nx: "NX"
- get: "GET"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8666
set(
    key: RedisKey,
    value: string | number | Buffer,
    millisecondsToken: "PX",
    milliseconds: string | number,
    xx: "XX",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- value: string | number | Buffer
- millisecondsToken: "PX"
- milliseconds: string | number
- xx: "XX"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8684
set(
    key: RedisKey,
    value: string | number | Buffer,
    millisecondsToken: "PX",
    milliseconds: string | number,
    xx: "XX",
    get: "GET",
    callback?: Callback<string>,
): Promise<string>
Parameters
- key: RedisKey
- value: string | number | Buffer
- millisecondsToken: "PX"
- milliseconds: string | number
- xx: "XX"
- get: "GET"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8692
set(
    key: RedisKey,
    value: string | number | Buffer,
    unixTimeSecondsToken: "EXAT",
    unixTimeSeconds: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- value: string | number | Buffer
- unixTimeSecondsToken: "EXAT"
- unixTimeSeconds: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8710
set(
    key: RedisKey,
    value: string | number | Buffer,
    unixTimeSecondsToken: "EXAT",
    unixTimeSeconds: string | number,
    get: "GET",
    callback?: Callback<string>,
): Promise<string>
Parameters
- key: RedisKey
- value: string | number | Buffer
- unixTimeSecondsToken: "EXAT"
- unixTimeSeconds: string | number
- get: "GET"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8717
set(
    key: RedisKey,
    value: string | number | Buffer,
    unixTimeSecondsToken: "EXAT",
    unixTimeSeconds: string | number,
    nx: "NX",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- value: string | number | Buffer
- unixTimeSecondsToken: "EXAT"
- unixTimeSeconds: string | number
- nx: "NX"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8733
set(
    key: RedisKey,
    value: string | number | Buffer,
    unixTimeSecondsToken: "EXAT",
    unixTimeSeconds: string | number,
    nx: "NX",
    get: "GET",
    callback?: Callback<string>,
): Promise<string>
Parameters
- key: RedisKey
- value: string | number | Buffer
- unixTimeSecondsToken: "EXAT"
- unixTimeSeconds: string | number
- nx: "NX"
- get: "GET"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8741
set(
    key: RedisKey,
    value: string | number | Buffer,
    unixTimeSecondsToken: "EXAT",
    unixTimeSeconds: string | number,
    xx: "XX",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- value: string | number | Buffer
- unixTimeSecondsToken: "EXAT"
- unixTimeSeconds: string | number
- xx: "XX"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8759
set(
    key: RedisKey,
    value: string | number | Buffer,
    unixTimeSecondsToken: "EXAT",
    unixTimeSeconds: string | number,
    xx: "XX",
    get: "GET",
    callback?: Callback<string>,
): Promise<string>
Parameters
- key: RedisKey
- value: string | number | Buffer
- unixTimeSecondsToken: "EXAT"
- unixTimeSeconds: string | number
- xx: "XX"
- get: "GET"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8767
set(
    key: RedisKey,
    value: string | number | Buffer,
    unixTimeMillisecondsToken: "PXAT",
    unixTimeMilliseconds: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- value: string | number | Buffer
- unixTimeMillisecondsToken: "PXAT"
- unixTimeMilliseconds: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8785
set(
    key: RedisKey,
    value: string | number | Buffer,
    unixTimeMillisecondsToken: "PXAT",
    unixTimeMilliseconds: string | number,
    get: "GET",
    callback?: Callback<string>,
): Promise<string>
Parameters
- key: RedisKey
- value: string | number | Buffer
- unixTimeMillisecondsToken: "PXAT"
- unixTimeMilliseconds: string | number
- get: "GET"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8792
set(
    key: RedisKey,
    value: string | number | Buffer,
    unixTimeMillisecondsToken: "PXAT",
    unixTimeMilliseconds: string | number,
    nx: "NX",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- value: string | number | Buffer
- unixTimeMillisecondsToken: "PXAT"
- unixTimeMilliseconds: string | number
- nx: "NX"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8808
set(
    key: RedisKey,
    value: string | number | Buffer,
    unixTimeMillisecondsToken: "PXAT",
    unixTimeMilliseconds: string | number,
    nx: "NX",
    get: "GET",
    callback?: Callback<string>,
): Promise<string>
Parameters
- key: RedisKey
- value: string | number | Buffer
- unixTimeMillisecondsToken: "PXAT"
- unixTimeMilliseconds: string | number
- nx: "NX"
- get: "GET"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8816
set(
    key: RedisKey,
    value: string | number | Buffer,
    unixTimeMillisecondsToken: "PXAT",
    unixTimeMilliseconds: string | number,
    xx: "XX",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- value: string | number | Buffer
- unixTimeMillisecondsToken: "PXAT"
- unixTimeMilliseconds: string | number
- xx: "XX"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8834
set(
    key: RedisKey,
    value: string | number | Buffer,
    unixTimeMillisecondsToken: "PXAT",
    unixTimeMilliseconds: string | number,
    xx: "XX",
    get: "GET",
    callback?: Callback<string>,
): Promise<string>
Parameters
- key: RedisKey
- value: string | number | Buffer
- unixTimeMillisecondsToken: "PXAT"
- unixTimeMilliseconds: string | number
- xx: "XX"
- get: "GET"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8842
set(
    key: RedisKey,
    value: string | number | Buffer,
    keepttl: "KEEPTTL",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- value: string | number | Buffer
- keepttl: "KEEPTTL"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8860
set(
    key: RedisKey,
    value: string | number | Buffer,
    keepttl: "KEEPTTL",
    get: "GET",
    callback?: Callback<string>,
): Promise<string>
Parameters
- key: RedisKey
- value: string | number | Buffer
- keepttl: "KEEPTTL"
- get: "GET"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8866
set(
    key: RedisKey,
    value: string | number | Buffer,
    keepttl: "KEEPTTL",
    nx: "NX",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- value: string | number | Buffer
- keepttl: "KEEPTTL"
- nx: "NX"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8880
set(
    key: RedisKey,
    value: string | number | Buffer,
    keepttl: "KEEPTTL",
    nx: "NX",
    get: "GET",
    callback?: Callback<string>,
): Promise<string>
Parameters
- key: RedisKey
- value: string | number | Buffer
- keepttl: "KEEPTTL"
- nx: "NX"
- get: "GET"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8887
set(
    key: RedisKey,
    value: string | number | Buffer,
    keepttl: "KEEPTTL",
    xx: "XX",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- key: RedisKey
- value: string | number | Buffer
- keepttl: "KEEPTTL"
- xx: "XX"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8903
set(
    key: RedisKey,
    value: string | number | Buffer,
    keepttl: "KEEPTTL",
    xx: "XX",
    get: "GET",
    callback?: Callback<string>,
): Promise<string>
Parameters
- key: RedisKey
- value: string | number | Buffer
- keepttl: "KEEPTTL"
- xx: "XX"
- get: "GET"
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.set
- Defined in utils/RedisCommander.ts:8910

setbit

setbit(
    key: RedisKey,
    offset: string | number,
    value: string | number,
    callback?: Callback<number>,
): Promise<number>
Sets or clears the bit at offset of the string value. Creates the key if it doesn't exist.
- group: bitmap
- complexity: O(1)
- since: 2.2.0
Parameters
- key: RedisKey
- offset: string | number
- value: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.setbit
- Defined in utils/RedisCommander.ts:8933

setBuffer

setBuffer(
    key: RedisKey,
    value: string | number | Buffer,
    get: "GET",
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- value: string | number | Buffer
- get: "GET"
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.setBuffer
- Defined in utils/RedisCommander.ts:8514
setBuffer(
    key: RedisKey,
    value: string | number | Buffer,
    nx: "NX",
    get: "GET",
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- value: string | number | Buffer
- nx: "NX"
- get: "GET"
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.setBuffer
- Defined in utils/RedisCommander.ts:8533
setBuffer(
    key: RedisKey,
    value: string | number | Buffer,
    xx: "XX",
    get: "GET",
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- value: string | number | Buffer
- xx: "XX"
- get: "GET"
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.setBuffer
- Defined in utils/RedisCommander.ts:8553
setBuffer(
    key: RedisKey,
    value: string | number | Buffer,
    secondsToken: "EX",
    seconds: string | number,
    get: "GET",
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- value: string | number | Buffer
- secondsToken: "EX"
- seconds: string | number
- get: "GET"
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.setBuffer
- Defined in utils/RedisCommander.ts:8575
setBuffer(
    key: RedisKey,
    value: string | number | Buffer,
    secondsToken: "EX",
    seconds: string | number,
    nx: "NX",
    get: "GET",
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- value: string | number | Buffer
- secondsToken: "EX"
- seconds: string | number
- nx: "NX"
- get: "GET"
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.setBuffer
- Defined in utils/RedisCommander.ts:8600
setBuffer(
    key: RedisKey,
    value: string | number | Buffer,
    secondsToken: "EX",
    seconds: string | number,
    xx: "XX",
    get: "GET",
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- value: string | number | Buffer
- secondsToken: "EX"
- seconds: string | number
- xx: "XX"
- get: "GET"
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.setBuffer
- Defined in utils/RedisCommander.ts:8626
setBuffer(
    key: RedisKey,
    value: string | number | Buffer,
    millisecondsToken: "PX",
    milliseconds: string | number,
    get: "GET",
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- value: string | number | Buffer
- millisecondsToken: "PX"
- milliseconds: string | number
- get: "GET"
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.setBuffer
- Defined in utils/RedisCommander.ts:8650
setBuffer(
    key: RedisKey,
    value: string | number | Buffer,
    millisecondsToken: "PX",
    milliseconds: string | number,
    nx: "NX",
    get: "GET",
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- value: string | number | Buffer
- millisecondsToken: "PX"
- milliseconds: string | number
- nx: "NX"
- get: "GET"
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.setBuffer
- Defined in utils/RedisCommander.ts:8675
setBuffer(
    key: RedisKey,
    value: string | number | Buffer,
    millisecondsToken: "PX",
    milliseconds: string | number,
    xx: "XX",
    get: "GET",
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- value: string | number | Buffer
- millisecondsToken: "PX"
- milliseconds: string | number
- xx: "XX"
- get: "GET"
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.setBuffer
- Defined in utils/RedisCommander.ts:8701
setBuffer(
    key: RedisKey,
    value: string | number | Buffer,
    unixTimeSecondsToken: "EXAT",
    unixTimeSeconds: string | number,
    get: "GET",
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- value: string | number | Buffer
- unixTimeSecondsToken: "EXAT"
- unixTimeSeconds: string | number
- get: "GET"
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.setBuffer
- Defined in utils/RedisCommander.ts:8725
setBuffer(
    key: RedisKey,
    value: string | number | Buffer,
    unixTimeSecondsToken: "EXAT",
    unixTimeSeconds: string | number,
    nx: "NX",
    get: "GET",
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- value: string | number | Buffer
- unixTimeSecondsToken: "EXAT"
- unixTimeSeconds: string | number
- nx: "NX"
- get: "GET"
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.setBuffer
- Defined in utils/RedisCommander.ts:8750
setBuffer(
    key: RedisKey,
    value: string | number | Buffer,
    unixTimeSecondsToken: "EXAT",
    unixTimeSeconds: string | number,
    xx: "XX",
    get: "GET",
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- value: string | number | Buffer
- unixTimeSecondsToken: "EXAT"
- unixTimeSeconds: string | number
- xx: "XX"
- get: "GET"
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.setBuffer
- Defined in utils/RedisCommander.ts:8776
setBuffer(
    key: RedisKey,
    value: string | number | Buffer,
    unixTimeMillisecondsToken: "PXAT",
    unixTimeMilliseconds: string | number,
    get: "GET",
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- value: string | number | Buffer
- unixTimeMillisecondsToken: "PXAT"
- unixTimeMilliseconds: string | number
- get: "GET"
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.setBuffer
- Defined in utils/RedisCommander.ts:8800
setBuffer(
    key: RedisKey,
    value: string | number | Buffer,
    unixTimeMillisecondsToken: "PXAT",
    unixTimeMilliseconds: string | number,
    nx: "NX",
    get: "GET",
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- value: string | number | Buffer
- unixTimeMillisecondsToken: "PXAT"
- unixTimeMilliseconds: string | number
- nx: "NX"
- get: "GET"
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.setBuffer
- Defined in utils/RedisCommander.ts:8825
setBuffer(
    key: RedisKey,
    value: string | number | Buffer,
    unixTimeMillisecondsToken: "PXAT",
    unixTimeMilliseconds: string | number,
    xx: "XX",
    get: "GET",
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- value: string | number | Buffer
- unixTimeMillisecondsToken: "PXAT"
- unixTimeMilliseconds: string | number
- xx: "XX"
- get: "GET"
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.setBuffer
- Defined in utils/RedisCommander.ts:8851
setBuffer(
    key: RedisKey,
    value: string | number | Buffer,
    keepttl: "KEEPTTL",
    get: "GET",
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- value: string | number | Buffer
- keepttl: "KEEPTTL"
- get: "GET"
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.setBuffer
- Defined in utils/RedisCommander.ts:8873
setBuffer(
    key: RedisKey,
    value: string | number | Buffer,
    keepttl: "KEEPTTL",
    nx: "NX",
    get: "GET",
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- value: string | number | Buffer
- keepttl: "KEEPTTL"
- nx: "NX"
- get: "GET"
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.setBuffer
- Defined in utils/RedisCommander.ts:8895
setBuffer(
    key: RedisKey,
    value: string | number | Buffer,
    keepttl: "KEEPTTL",
    xx: "XX",
    get: "GET",
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- value: string | number | Buffer
- keepttl: "KEEPTTL"
- xx: "XX"
- get: "GET"
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.setBuffer
- Defined in utils/RedisCommander.ts:8918

setex

setex(
    key: RedisKey,
    seconds: string | number,
    value: string | number | Buffer,
    callback?: Callback<"OK">,
): Promise<"OK">
Sets the string value and expiration time of a key. Creates the key if it doesn't exist.
- group: string
- complexity: O(1)
- since: 2.0.0
Parameters
- key: RedisKey
- seconds: string | number
- value: string | number | Buffer
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.setex
- Defined in utils/RedisCommander.ts:8946

setnx

setnx(
    key: RedisKey,
    value: string | number | Buffer,
    callback?: Callback<number>,
): Promise<number>
Set the string value of a key only when the key doesn't exist.
- group: string
- complexity: O(1)
- since: 1.0.0
Parameters
- key: RedisKey
- value: string | number | Buffer
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.setnx
- Defined in utils/RedisCommander.ts:8959

setrange

setrange(
    key: RedisKey,
    offset: string | number,
    value: string | number | Buffer,
    callback?: Callback<number>,
): Promise<number>
Overwrites a part of a string value with another by an offset. Creates the key if it doesn't exist.
- group: string
- complexity: O(1), not counting the time taken to copy the new string in place. Usually, this string is very small so the amortized complexity is O(1). Otherwise, complexity is O(M) with M being the length of the value argument.
- since: 2.2.0
Parameters
- key: RedisKey
- offset: string | number
- value: string | number | Buffer
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.setrange
- Defined in utils/RedisCommander.ts:8971

shutdown

shutdown(callback?: Callback<"OK">): Promise<"OK">
Synchronously saves the database(s) to disk and shuts down the server.
- group: server
- complexity: O(N) when saving, where N is the total number of keys in all databases when saving data, otherwise O(1)
- since: 1.0.0
Parameters
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.shutdown
- Defined in utils/RedisCommander.ts:8984
shutdown(callback?: Callback<"OK">): Promise<"OK">
Parameters
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.shutdown
- Defined in utils/RedisCommander.ts:8985
shutdown(force: "FORCE", callback?: Callback<"OK">): Promise<"OK">
Parameters
- force: "FORCE"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.shutdown
- Defined in utils/RedisCommander.ts:8986
shutdown(now: "NOW", callback?: Callback<"OK">): Promise<"OK">
Parameters
- now: "NOW"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.shutdown
- Defined in utils/RedisCommander.ts:8987
shutdown(now: "NOW", force: "FORCE", callback?: Callback<"OK">): Promise<"OK">
Parameters
- now: "NOW"
- force: "FORCE"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.shutdown
- Defined in utils/RedisCommander.ts:8988
shutdown(nosave: "NOSAVE", callback?: Callback<"OK">): Promise<"OK">
Parameters
- nosave: "NOSAVE"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.shutdown
- Defined in utils/RedisCommander.ts:8993
shutdown(
    nosave: "NOSAVE",
    force: "FORCE",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- nosave: "NOSAVE"
- force: "FORCE"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.shutdown
- Defined in utils/RedisCommander.ts:8994
shutdown(nosave: "NOSAVE", now: "NOW", callback?: Callback<"OK">): Promise<"OK">
Parameters
- nosave: "NOSAVE"
- now: "NOW"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.shutdown
- Defined in utils/RedisCommander.ts:8999
shutdown(
    nosave: "NOSAVE",
    now: "NOW",
    force: "FORCE",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- nosave: "NOSAVE"
- now: "NOW"
- force: "FORCE"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.shutdown
- Defined in utils/RedisCommander.ts:9004
shutdown(save: "SAVE", callback?: Callback<"OK">): Promise<"OK">
Parameters
- save: "SAVE"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.shutdown
- Defined in utils/RedisCommander.ts:9010
shutdown(save: "SAVE", force: "FORCE", callback?: Callback<"OK">): Promise<"OK">
Parameters
- save: "SAVE"
- force: "FORCE"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.shutdown
- Defined in utils/RedisCommander.ts:9011
shutdown(save: "SAVE", now: "NOW", callback?: Callback<"OK">): Promise<"OK">
Parameters
- save: "SAVE"
- now: "NOW"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.shutdown
- Defined in utils/RedisCommander.ts:9016
shutdown(
    save: "SAVE",
    now: "NOW",
    force: "FORCE",
    callback?: Callback<"OK">,
): Promise<"OK">
Parameters
- save: "SAVE"
- now: "NOW"
- force: "FORCE"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.shutdown
- Defined in utils/RedisCommander.ts:9021
shutdown(abort: "ABORT", callback?: Callback<"OK">): Promise<"OK">
Parameters
- abort: "ABORT"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.shutdown
- Defined in utils/RedisCommander.ts:9027

sinter

sinter(
...args: [...keys: RedisKey[], callback: Callback<string[]>],
): Promise<string[]>
Returns the intersect of multiple sets.
- group: set
- complexity: O(N*M) worst case where N is the cardinality of the smallest set and M is the number of sets.
- since: 1.0.0
Parameters
- ...args: [...keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Inherited from Commander.sinter
- Defined in utils/RedisCommander.ts:9035
sinter(
...args: [keys: RedisKey[], callback: Callback<string[]>],
): Promise<string[]>
Parameters
- ...args: [keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Inherited from Commander.sinter
- Defined in utils/RedisCommander.ts:9041
sinter(...args: RedisKey[]): Promise<string[]>
Parameters
- ...args: RedisKey[]
Returns Promise<string[]>
Inherited from Commander.sinter
- Defined in utils/RedisCommander.ts:9047
sinter(...args: [keys: RedisKey[]]): Promise<string[]>
Parameters
- ...args: [keys: RedisKey[]]
Returns Promise<string[]>
Inherited from Commander.sinter
- Defined in utils/RedisCommander.ts:9049

sinterBuffer

sinterBuffer(
...args: [...keys: RedisKey[], callback: Callback<Buffer[]>],
): Promise<Buffer[]>
Parameters
- ...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Inherited from Commander.sinterBuffer
- Defined in utils/RedisCommander.ts:9038
sinterBuffer(
...args: [keys: RedisKey[], callback: Callback<Buffer[]>],
): Promise<Buffer[]>
Parameters
- ...args: [keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Inherited from Commander.sinterBuffer
- Defined in utils/RedisCommander.ts:9044
sinterBuffer(...args: RedisKey[]): Promise<Buffer[]>
Parameters
- ...args: RedisKey[]
Returns Promise<Buffer[]>
Inherited from Commander.sinterBuffer
- Defined in utils/RedisCommander.ts:9048
sinterBuffer(...args: [keys: RedisKey[]]): Promise<Buffer[]>
Parameters
- ...args: [keys: RedisKey[]]
Returns Promise<Buffer[]>
Inherited from Commander.sinterBuffer
- Defined in utils/RedisCommander.ts:9050

sintercard

sintercard(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        callback: Callback<number>,
    ],
): Promise<number>
Returns the number of members of the intersect of multiple sets.
- group: set
- complexity: O(N*M) worst case where N is the cardinality of the smallest set and M is the number of sets.
- since: 7.0.0
Parameters
- ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Inherited from Commander.sintercard
- Defined in utils/RedisCommander.ts:9058
sintercard(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Inherited from Commander.sintercard
- Defined in utils/RedisCommander.ts:9065
sintercard(
...args: [numkeys: string | number, ...keys: RedisKey[]],
): Promise<number>
Parameters
- ...args: [numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<number>
Inherited from Commander.sintercard
- Defined in utils/RedisCommander.ts:9072
sintercard(
...args: [numkeys: string | number, keys: RedisKey[]],
): Promise<number>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[]]
Returns Promise<number>
Inherited from Commander.sintercard
- Defined in utils/RedisCommander.ts:9075
sintercard(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        limitToken: "LIMIT",
        limit: string | number,
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      limitToken: "LIMIT",
      limit: string | number,
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.sintercard
- Defined in utils/RedisCommander.ts:9078
sintercard(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        limitToken: "LIMIT",
        limit: string | number,
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      limitToken: "LIMIT",
      limit: string | number,
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.sintercard
- Defined in utils/RedisCommander.ts:9087
sintercard(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        limitToken: "LIMIT",
        limit: string | number,
    ],
): Promise<number>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      limitToken: "LIMIT",
      limit: string | number,
  ]
Returns Promise<number>
Inherited from Commander.sintercard
- Defined in utils/RedisCommander.ts:9096
sintercard(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        limitToken: "LIMIT",
        limit: string | number,
    ],
): Promise<number>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      limitToken: "LIMIT",
      limit: string | number,
  ]
Returns Promise<number>
Inherited from Commander.sintercard
- Defined in utils/RedisCommander.ts:9104

sinterstore

sinterstore(
    ...args: [
        destination: RedisKey,
        ...keys: RedisKey[],
        callback: Callback<number>,
    ],
): Promise<number>
Stores the intersect of multiple sets in a key.
- group: set
- complexity: O(N*M) worst case where N is the cardinality of the smallest set and M is the number of sets.
- since: 1.0.0
Parameters
- ...args: [destination: RedisKey, ...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Inherited from Commander.sinterstore
- Defined in utils/RedisCommander.ts:9119
sinterstore(
    ...args: [
        destination: RedisKey,
        keys: RedisKey[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [destination: RedisKey, keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Inherited from Commander.sinterstore
- Defined in utils/RedisCommander.ts:9126
sinterstore(
...args: [destination: RedisKey, ...keys: RedisKey[]],
): Promise<number>
Parameters
- ...args: [destination: RedisKey, ...keys: RedisKey[]]
Returns Promise<number>
Inherited from Commander.sinterstore
- Defined in utils/RedisCommander.ts:9133
sinterstore(...args: [destination: RedisKey, keys: RedisKey[]]): Promise<number>
Parameters
- ...args: [destination: RedisKey, keys: RedisKey[]]
Returns Promise<number>
Inherited from Commander.sinterstore
- Defined in utils/RedisCommander.ts:9136

sismember

sismember(
    key: RedisKey,
    member: string | number | Buffer,
    callback?: Callback<number>,
): Promise<number>
Determines whether a member belongs to a set.
- group: set
- complexity: O(1)
- since: 1.0.0
Parameters
- key: RedisKey
- member: string | number | Buffer
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.sismember
- Defined in utils/RedisCommander.ts:9146

slaveof

slaveof(
    host: string | Buffer,
    port: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Sets a server as a replica of another, or promotes it to being a primary.
- group: server
- complexity: O(1)
- since: 1.0.0
Parameters
- host: string | Buffer
- port: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.slaveof
- Defined in utils/RedisCommander.ts:9158
slaveof(no: "NO", one: "ONE", callback?: Callback<"OK">): Promise<"OK">
Parameters
- no: "NO"
- one: "ONE"
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.slaveof
- Defined in utils/RedisCommander.ts:9163

slowlog

slowlog(subcommand: "GET", callback?: Callback<unknown>): Promise<unknown>
Returns the slow log's entries.
- group: server
- complexity: O(N) where N is the number of entries returned
- since: 2.2.12
Parameters
- subcommand: "GET"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.slowlog
- Defined in utils/RedisCommander.ts:9175
slowlog(
    subcommand: "GET",
    count: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "GET"
- count: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.slowlog
- Defined in utils/RedisCommander.ts:9179
slowlog(subcommand: "HELP", callback?: Callback<unknown>): Promise<unknown>
Show helpful text about the different subcommands
- group: server
- complexity: O(1)
- since: 6.2.0
Parameters
- subcommand: "HELP"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.slowlog
- Defined in utils/RedisCommander.ts:9191
slowlog(subcommand: "LEN", callback?: Callback<unknown>): Promise<unknown>
Returns the number of entries in the slow log.
- group: server
- complexity: O(1)
- since: 2.2.12
Parameters
- subcommand: "LEN"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.slowlog
- Defined in utils/RedisCommander.ts:9202
slowlog(subcommand: "RESET", callback?: Callback<unknown>): Promise<unknown>
Clears all entries from the slow log.
- group: server
- complexity: O(N) where N is the number of entries in the slowlog
- since: 2.2.12
Parameters
- subcommand: "RESET"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.slowlog
- Defined in utils/RedisCommander.ts:9213

smembers

smembers(key: RedisKey, callback?: Callback<string[]>): Promise<string[]>
Returns all members of a set.
- group: set
- complexity: O(N) where N is the set cardinality.
- since: 1.0.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.smembers
- Defined in utils/RedisCommander.ts:9224

smembersBuffer

smembersBuffer(key: RedisKey, callback?: Callback<Buffer[]>): Promise<Buffer[]>
Parameters
- key: RedisKey
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.smembersBuffer
- Defined in utils/RedisCommander.ts:9228

smismember

smismember(
    ...args: [
        key: RedisKey,
        ...members: (string | number | Buffer)[],
        callback: Callback<number[]>,
    ],
): Promise<number[]>
Determines whether multiple members belong to a set.
- group: set
- complexity: O(N) where N is the number of elements being checked for membership
- since: 6.2.0
Parameters
- ...args: [
      key: RedisKey,
      ...members: (string | number | Buffer)[],
      callback: Callback<number[]>,
  ]
Returns Promise<number[]>
Inherited from Commander.smismember
- Defined in utils/RedisCommander.ts:9239
smismember(
    ...args: [
        key: RedisKey,
        members: (string | number | Buffer)[],
        callback: Callback<number[]>,
    ],
): Promise<number[]>
Parameters
- ...args: [
      key: RedisKey,
      members: (string | number | Buffer)[],
      callback: Callback<number[]>,
  ]
Returns Promise<number[]>
Inherited from Commander.smismember
- Defined in utils/RedisCommander.ts:9246
smismember(
...args: [key: RedisKey, ...members: (string | number | Buffer)[]],
): Promise<number[]>
Parameters
- ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns Promise<number[]>
Inherited from Commander.smismember
- Defined in utils/RedisCommander.ts:9253
smismember(
...args: [key: RedisKey, members: (string | number | Buffer)[]],
): Promise<number[]>
Parameters
- ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns Promise<number[]>
Inherited from Commander.smismember
- Defined in utils/RedisCommander.ts:9256

smove

smove(
    source: RedisKey,
    destination: RedisKey,
    member: string | number | Buffer,
    callback?: Callback<number>,
): Promise<number>
Moves a member from one set to another.
- group: set
- complexity: O(1)
- since: 1.0.0
Parameters
- source: RedisKey
- destination: RedisKey
- member: string | number | Buffer
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.smove
- Defined in utils/RedisCommander.ts:9266

sort

sort(
    ...args: [
        key: RedisKey,
        ...args: RedisValue[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Sorts the elements in a list, a set, or a sorted set, optionally storing the result.
- group: generic
- complexity: O(N+M*log(M)) where N is the number of elements in the list or set to sort, and M the number of returned elements. When the elements are not sorted, complexity is O(N).
- since: 1.0.0
Parameters
- ...args: [key: RedisKey, ...args: RedisValue[], callback: Callback<unknown>]
Returns Promise<unknown>
Inherited from Commander.sort
- Defined in utils/RedisCommander.ts:9279
sort(...args: [key: RedisKey, ...args: RedisValue[]]): Promise<unknown>
Parameters
- ...args: [key: RedisKey, ...args: RedisValue[]]
Returns Promise<unknown>
Inherited from Commander.sort
- Defined in utils/RedisCommander.ts:9282

sort_ro

sort_ro(key: RedisKey, callback?: Callback<unknown>): Promise<unknown>
Returns the sorted elements of a list, a set, or a sorted set.
- group: generic
- complexity: O(N+M*log(M)) where N is the number of elements in the list or set to sort, and M the number of returned elements. When the elements are not sorted, complexity is O(N).
- since: 7.0.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9292
sort_ro(
    key: RedisKey,
    alpha: "ALPHA",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- alpha: "ALPHA"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9296
sort_ro(
    key: RedisKey,
    asc: "ASC",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- asc: "ASC"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9301
sort_ro(
    key: RedisKey,
    asc: "ASC",
    alpha: "ALPHA",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- asc: "ASC"
- alpha: "ALPHA"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9306
sort_ro(
    key: RedisKey,
    desc: "DESC",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- desc: "DESC"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9312
sort_ro(
    key: RedisKey,
    desc: "DESC",
    alpha: "ALPHA",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- desc: "DESC"
- alpha: "ALPHA"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9317
sort_ro(
    ...args: [
        key: RedisKey,
        getPatternToken: "GET",
        ...getPatterns: string[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      getPatternToken: "GET",
      ...getPatterns: string[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9323
sort_ro(
    ...args: [
        key: RedisKey,
        getPatternToken: "GET",
        ...getPatterns: string[],
    ],
): Promise<unknown>
Parameters
- ...args: [key: RedisKey, getPatternToken: "GET", ...getPatterns: string[]]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9331
sort_ro(
    ...args: [
        key: RedisKey,
        getPatternToken: "GET",
        ...getPatterns: string[],
        alpha: "ALPHA",
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      getPatternToken: "GET",
      ...getPatterns: string[],
      alpha: "ALPHA",
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9334
sort_ro(
    ...args: [
        key: RedisKey,
        getPatternToken: "GET",
        ...getPatterns: string[],
        alpha: "ALPHA",
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      getPatternToken: "GET",
      ...getPatterns: string[],
      alpha: "ALPHA",
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9343
sort_ro(
    ...args: [
        key: RedisKey,
        getPatternToken: "GET",
        ...getPatterns: string[],
        asc: "ASC",
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      getPatternToken: "GET",
      ...getPatterns: string[],
      asc: "ASC",
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9351
sort_ro(
    ...args: [
        key: RedisKey,
        getPatternToken: "GET",
        ...getPatterns: string[],
        asc: "ASC",
    ],
): Promise<unknown>
Parameters
- ...args: [key: RedisKey, getPatternToken: "GET", ...getPatterns: string[], asc: "ASC"]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9360
sort_ro(
    ...args: [
        key: RedisKey,
        getPatternToken: "GET",
        ...getPatterns: string[],
        asc: "ASC",
        alpha: "ALPHA",
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      getPatternToken: "GET",
      ...getPatterns: string[],
      asc: "ASC",
      alpha: "ALPHA",
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9368
sort_ro(
    ...args: [
        key: RedisKey,
        getPatternToken: "GET",
        ...getPatterns: string[],
        asc: "ASC",
        alpha: "ALPHA",
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      getPatternToken: "GET",
      ...getPatterns: string[],
      asc: "ASC",
      alpha: "ALPHA",
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9378
sort_ro(
    ...args: [
        key: RedisKey,
        getPatternToken: "GET",
        ...getPatterns: string[],
        desc: "DESC",
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      getPatternToken: "GET",
      ...getPatterns: string[],
      desc: "DESC",
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9387
sort_ro(
    ...args: [
        key: RedisKey,
        getPatternToken: "GET",
        ...getPatterns: string[],
        desc: "DESC",
    ],
): Promise<unknown>
Parameters
- ...args: [key: RedisKey, getPatternToken: "GET", ...getPatterns: string[], desc: "DESC"]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9396
sort_ro(
    ...args: [
        key: RedisKey,
        getPatternToken: "GET",
        ...getPatterns: string[],
        desc: "DESC",
        alpha: "ALPHA",
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      getPatternToken: "GET",
      ...getPatterns: string[],
      desc: "DESC",
      alpha: "ALPHA",
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9404
sort_ro(
    ...args: [
        key: RedisKey,
        getPatternToken: "GET",
        ...getPatterns: string[],
        desc: "DESC",
        alpha: "ALPHA",
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      getPatternToken: "GET",
      ...getPatterns: string[],
      desc: "DESC",
      alpha: "ALPHA",
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9414
sort_ro(
    key: RedisKey,
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9423
sort_ro(
    key: RedisKey,
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    alpha: "ALPHA",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- alpha: "ALPHA"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9430
sort_ro(
    key: RedisKey,
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    asc: "ASC",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- asc: "ASC"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9438
sort_ro(
    key: RedisKey,
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    asc: "ASC",
    alpha: "ALPHA",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- asc: "ASC"
- alpha: "ALPHA"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9446
sort_ro(
    key: RedisKey,
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    desc: "DESC",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- desc: "DESC"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9455
sort_ro(
    key: RedisKey,
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    desc: "DESC",
    alpha: "ALPHA",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- desc: "DESC"
- alpha: "ALPHA"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9463
sort_ro(
    ...args: [
        key: RedisKey,
        limitToken: "LIMIT",
        offset: string
        | number,
        count: string | number,
        getPatternToken: "GET",
        ...getPatterns: string[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      limitToken: "LIMIT",
      offset: string
      | number,
      count: string | number,
      getPatternToken: "GET",
      ...getPatterns: string[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9472
sort_ro(
    ...args: [
        key: RedisKey,
        limitToken: "LIMIT",
        offset: string
        | number,
        count: string | number,
        getPatternToken: "GET",
        ...getPatterns: string[],
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      limitToken: "LIMIT",
      offset: string
      | number,
      count: string | number,
      getPatternToken: "GET",
      ...getPatterns: string[],
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9483
sort_ro(
    ...args: [
        key: RedisKey,
        limitToken: "LIMIT",
        offset: string
        | number,
        count: string | number,
        getPatternToken: "GET",
        ...getPatterns: string[],
        alpha: "ALPHA",
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      limitToken: "LIMIT",
      offset: string
      | number,
      count: string | number,
      getPatternToken: "GET",
      ...getPatterns: string[],
      alpha: "ALPHA",
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9493
sort_ro(
    ...args: [
        key: RedisKey,
        limitToken: "LIMIT",
        offset: string
        | number,
        count: string | number,
        getPatternToken: "GET",
        ...getPatterns: string[],
        alpha: "ALPHA",
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      limitToken: "LIMIT",
      offset: string
      | number,
      count: string | number,
      getPatternToken: "GET",
      ...getPatterns: string[],
      alpha: "ALPHA",
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9505
sort_ro(
    ...args: [
        key: RedisKey,
        limitToken: "LIMIT",
        offset: string
        | number,
        count: string | number,
        getPatternToken: "GET",
        ...getPatterns: string[],
        asc: "ASC",
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      limitToken: "LIMIT",
      offset: string
      | number,
      count: string | number,
      getPatternToken: "GET",
      ...getPatterns: string[],
      asc: "ASC",
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9516
sort_ro(
    ...args: [
        key: RedisKey,
        limitToken: "LIMIT",
        offset: string
        | number,
        count: string | number,
        getPatternToken: "GET",
        ...getPatterns: string[],
        asc: "ASC",
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      limitToken: "LIMIT",
      offset: string
      | number,
      count: string | number,
      getPatternToken: "GET",
      ...getPatterns: string[],
      asc: "ASC",
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9528
sort_ro(
    ...args: [
        key: RedisKey,
        limitToken: "LIMIT",
        offset: string
        | number,
        count: string | number,
        getPatternToken: "GET",
        ...getPatterns: string[],
        asc: "ASC",
        alpha: "ALPHA",
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      limitToken: "LIMIT",
      offset: string
      | number,
      count: string | number,
      getPatternToken: "GET",
      ...getPatterns: string[],
      asc: "ASC",
      alpha: "ALPHA",
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9539
sort_ro(
    ...args: [
        key: RedisKey,
        limitToken: "LIMIT",
        offset: string
        | number,
        count: string | number,
        getPatternToken: "GET",
        ...getPatterns: string[],
        asc: "ASC",
        alpha: "ALPHA",
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      limitToken: "LIMIT",
      offset: string
      | number,
      count: string | number,
      getPatternToken: "GET",
      ...getPatterns: string[],
      asc: "ASC",
      alpha: "ALPHA",
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9552
sort_ro(
    ...args: [
        key: RedisKey,
        limitToken: "LIMIT",
        offset: string
        | number,
        count: string | number,
        getPatternToken: "GET",
        ...getPatterns: string[],
        desc: "DESC",
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      limitToken: "LIMIT",
      offset: string
      | number,
      count: string | number,
      getPatternToken: "GET",
      ...getPatterns: string[],
      desc: "DESC",
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9564
sort_ro(
    ...args: [
        key: RedisKey,
        limitToken: "LIMIT",
        offset: string
        | number,
        count: string | number,
        getPatternToken: "GET",
        ...getPatterns: string[],
        desc: "DESC",
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      limitToken: "LIMIT",
      offset: string
      | number,
      count: string | number,
      getPatternToken: "GET",
      ...getPatterns: string[],
      desc: "DESC",
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9576
sort_ro(
    ...args: [
        key: RedisKey,
        limitToken: "LIMIT",
        offset: string
        | number,
        count: string | number,
        getPatternToken: "GET",
        ...getPatterns: string[],
        desc: "DESC",
        alpha: "ALPHA",
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      limitToken: "LIMIT",
      offset: string
      | number,
      count: string | number,
      getPatternToken: "GET",
      ...getPatterns: string[],
      desc: "DESC",
      alpha: "ALPHA",
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9587
sort_ro(
    ...args: [
        key: RedisKey,
        limitToken: "LIMIT",
        offset: string
        | number,
        count: string | number,
        getPatternToken: "GET",
        ...getPatterns: string[],
        desc: "DESC",
        alpha: "ALPHA",
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      limitToken: "LIMIT",
      offset: string
      | number,
      count: string | number,
      getPatternToken: "GET",
      ...getPatterns: string[],
      desc: "DESC",
      alpha: "ALPHA",
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9600
sort_ro(
    key: RedisKey,
    byPatternToken: "BY",
    byPattern: string,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- byPatternToken: "BY"
- byPattern: string
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9612
sort_ro(
    key: RedisKey,
    byPatternToken: "BY",
    byPattern: string,
    alpha: "ALPHA",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- byPatternToken: "BY"
- byPattern: string
- alpha: "ALPHA"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9618
sort_ro(
    key: RedisKey,
    byPatternToken: "BY",
    byPattern: string,
    asc: "ASC",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- byPatternToken: "BY"
- byPattern: string
- asc: "ASC"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9625
sort_ro(
    key: RedisKey,
    byPatternToken: "BY",
    byPattern: string,
    asc: "ASC",
    alpha: "ALPHA",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- byPatternToken: "BY"
- byPattern: string
- asc: "ASC"
- alpha: "ALPHA"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9632
sort_ro(
    key: RedisKey,
    byPatternToken: "BY",
    byPattern: string,
    desc: "DESC",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- byPatternToken: "BY"
- byPattern: string
- desc: "DESC"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9640
sort_ro(
    key: RedisKey,
    byPatternToken: "BY",
    byPattern: string,
    desc: "DESC",
    alpha: "ALPHA",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- byPatternToken: "BY"
- byPattern: string
- desc: "DESC"
- alpha: "ALPHA"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9647
sort_ro(
    ...args: [
        key: RedisKey,
        byPatternToken: "BY",
        byPattern: string,
        getPatternToken: "GET",
        ...getPatterns: string[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      byPatternToken: "BY",
      byPattern: string,
      getPatternToken: "GET",
      ...getPatterns: string[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9655
sort_ro(
    ...args: [
        key: RedisKey,
        byPatternToken: "BY",
        byPattern: string,
        getPatternToken: "GET",
        ...getPatterns: string[],
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      byPatternToken: "BY",
      byPattern: string,
      getPatternToken: "GET",
      ...getPatterns: string[],
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9665
sort_ro(
    ...args: [
        key: RedisKey,
        byPatternToken: "BY",
        byPattern: string,
        getPatternToken: "GET",
        ...getPatterns: string[],
        alpha: "ALPHA",
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      byPatternToken: "BY",
      byPattern: string,
      getPatternToken: "GET",
      ...getPatterns: string[],
      alpha: "ALPHA",
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9674
sort_ro(
    ...args: [
        key: RedisKey,
        byPatternToken: "BY",
        byPattern: string,
        getPatternToken: "GET",
        ...getPatterns: string[],
        alpha: "ALPHA",
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      byPatternToken: "BY",
      byPattern: string,
      getPatternToken: "GET",
      ...getPatterns: string[],
      alpha: "ALPHA",
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9685
sort_ro(
    ...args: [
        key: RedisKey,
        byPatternToken: "BY",
        byPattern: string,
        getPatternToken: "GET",
        ...getPatterns: string[],
        asc: "ASC",
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      byPatternToken: "BY",
      byPattern: string,
      getPatternToken: "GET",
      ...getPatterns: string[],
      asc: "ASC",
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9695
sort_ro(
    ...args: [
        key: RedisKey,
        byPatternToken: "BY",
        byPattern: string,
        getPatternToken: "GET",
        ...getPatterns: string[],
        asc: "ASC",
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      byPatternToken: "BY",
      byPattern: string,
      getPatternToken: "GET",
      ...getPatterns: string[],
      asc: "ASC",
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9706
sort_ro(
    ...args: [
        key: RedisKey,
        byPatternToken: "BY",
        byPattern: string,
        getPatternToken: "GET",
        ...getPatterns: string[],
        asc: "ASC",
        alpha: "ALPHA",
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      byPatternToken: "BY",
      byPattern: string,
      getPatternToken: "GET",
      ...getPatterns: string[],
      asc: "ASC",
      alpha: "ALPHA",
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9716
sort_ro(
    ...args: [
        key: RedisKey,
        byPatternToken: "BY",
        byPattern: string,
        getPatternToken: "GET",
        ...getPatterns: string[],
        asc: "ASC",
        alpha: "ALPHA",
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      byPatternToken: "BY",
      byPattern: string,
      getPatternToken: "GET",
      ...getPatterns: string[],
      asc: "ASC",
      alpha: "ALPHA",
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9728
sort_ro(
    ...args: [
        key: RedisKey,
        byPatternToken: "BY",
        byPattern: string,
        getPatternToken: "GET",
        ...getPatterns: string[],
        desc: "DESC",
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      byPatternToken: "BY",
      byPattern: string,
      getPatternToken: "GET",
      ...getPatterns: string[],
      desc: "DESC",
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9739
sort_ro(
    ...args: [
        key: RedisKey,
        byPatternToken: "BY",
        byPattern: string,
        getPatternToken: "GET",
        ...getPatterns: string[],
        desc: "DESC",
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      byPatternToken: "BY",
      byPattern: string,
      getPatternToken: "GET",
      ...getPatterns: string[],
      desc: "DESC",
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9750
sort_ro(
    ...args: [
        key: RedisKey,
        byPatternToken: "BY",
        byPattern: string,
        getPatternToken: "GET",
        ...getPatterns: string[],
        desc: "DESC",
        alpha: "ALPHA",
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      byPatternToken: "BY",
      byPattern: string,
      getPatternToken: "GET",
      ...getPatterns: string[],
      desc: "DESC",
      alpha: "ALPHA",
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9760
sort_ro(
    ...args: [
        key: RedisKey,
        byPatternToken: "BY",
        byPattern: string,
        getPatternToken: "GET",
        ...getPatterns: string[],
        desc: "DESC",
        alpha: "ALPHA",
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      byPatternToken: "BY",
      byPattern: string,
      getPatternToken: "GET",
      ...getPatterns: string[],
      desc: "DESC",
      alpha: "ALPHA",
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9772
sort_ro(
    key: RedisKey,
    byPatternToken: "BY",
    byPattern: string,
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- byPatternToken: "BY"
- byPattern: string
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9783
sort_ro(
    key: RedisKey,
    byPatternToken: "BY",
    byPattern: string,
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    alpha: "ALPHA",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- byPatternToken: "BY"
- byPattern: string
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- alpha: "ALPHA"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9792
sort_ro(
    key: RedisKey,
    byPatternToken: "BY",
    byPattern: string,
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    asc: "ASC",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- byPatternToken: "BY"
- byPattern: string
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- asc: "ASC"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9802
sort_ro(
    key: RedisKey,
    byPatternToken: "BY",
    byPattern: string,
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    asc: "ASC",
    alpha: "ALPHA",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- byPatternToken: "BY"
- byPattern: string
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- asc: "ASC"
- alpha: "ALPHA"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9812
sort_ro(
    key: RedisKey,
    byPatternToken: "BY",
    byPattern: string,
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    desc: "DESC",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- byPatternToken: "BY"
- byPattern: string
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- desc: "DESC"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9823
sort_ro(
    key: RedisKey,
    byPatternToken: "BY",
    byPattern: string,
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    desc: "DESC",
    alpha: "ALPHA",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- byPatternToken: "BY"
- byPattern: string
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- desc: "DESC"
- alpha: "ALPHA"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9833
sort_ro(
    ...args: [
        key: RedisKey,
        byPatternToken: "BY",
        byPattern: string,
        limitToken: "LIMIT",
        offset: string
        | number,
        count: string | number,
        getPatternToken: "GET",
        ...getPatterns: string[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      byPatternToken: "BY",
      byPattern: string,
      limitToken: "LIMIT",
      offset: string
      | number,
      count: string | number,
      getPatternToken: "GET",
      ...getPatterns: string[],
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9844
sort_ro(
    ...args: [
        key: RedisKey,
        byPatternToken: "BY",
        byPattern: string,
        limitToken: "LIMIT",
        offset: string
        | number,
        count: string | number,
        getPatternToken: "GET",
        ...getPatterns: string[],
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      byPatternToken: "BY",
      byPattern: string,
      limitToken: "LIMIT",
      offset: string
      | number,
      count: string | number,
      getPatternToken: "GET",
      ...getPatterns: string[],
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9857
sort_ro(
    ...args: [
        key: RedisKey,
        byPatternToken: "BY",
        byPattern: string,
        limitToken: "LIMIT",
        offset: string
        | number,
        count: string | number,
        getPatternToken: "GET",
        ...getPatterns: string[],
        alpha: "ALPHA",
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      byPatternToken: "BY",
      byPattern: string,
      limitToken: "LIMIT",
      offset: string
      | number,
      count: string | number,
      getPatternToken: "GET",
      ...getPatterns: string[],
      alpha: "ALPHA",
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9869
sort_ro(
    ...args: [
        key: RedisKey,
        byPatternToken: "BY",
        byPattern: string,
        limitToken: "LIMIT",
        offset: string
        | number,
        count: string | number,
        getPatternToken: "GET",
        ...getPatterns: string[],
        alpha: "ALPHA",
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      byPatternToken: "BY",
      byPattern: string,
      limitToken: "LIMIT",
      offset: string
      | number,
      count: string | number,
      getPatternToken: "GET",
      ...getPatterns: string[],
      alpha: "ALPHA",
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9883
sort_ro(
    ...args: [
        key: RedisKey,
        byPatternToken: "BY",
        byPattern: string,
        limitToken: "LIMIT",
        offset: string
        | number,
        count: string | number,
        getPatternToken: "GET",
        ...getPatterns: string[],
        asc: "ASC",
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      byPatternToken: "BY",
      byPattern: string,
      limitToken: "LIMIT",
      offset: string
      | number,
      count: string | number,
      getPatternToken: "GET",
      ...getPatterns: string[],
      asc: "ASC",
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9896
sort_ro(
    ...args: [
        key: RedisKey,
        byPatternToken: "BY",
        byPattern: string,
        limitToken: "LIMIT",
        offset: string
        | number,
        count: string | number,
        getPatternToken: "GET",
        ...getPatterns: string[],
        asc: "ASC",
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      byPatternToken: "BY",
      byPattern: string,
      limitToken: "LIMIT",
      offset: string
      | number,
      count: string | number,
      getPatternToken: "GET",
      ...getPatterns: string[],
      asc: "ASC",
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9910
sort_ro(
    ...args: [
        key: RedisKey,
        byPatternToken: "BY",
        byPattern: string,
        limitToken: "LIMIT",
        offset: string
        | number,
        count: string | number,
        getPatternToken: "GET",
        ...getPatterns: string[],
        asc: "ASC",
        alpha: "ALPHA",
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      byPatternToken: "BY",
      byPattern: string,
      limitToken: "LIMIT",
      offset: string
      | number,
      count: string | number,
      getPatternToken: "GET",
      ...getPatterns: string[],
      asc: "ASC",
      alpha: "ALPHA",
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9923
sort_ro(
    ...args: [
        key: RedisKey,
        byPatternToken: "BY",
        byPattern: string,
        limitToken: "LIMIT",
        offset: string
        | number,
        count: string | number,
        getPatternToken: "GET",
        ...getPatterns: string[],
        asc: "ASC",
        alpha: "ALPHA",
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      byPatternToken: "BY",
      byPattern: string,
      limitToken: "LIMIT",
      offset: string
      | number,
      count: string | number,
      getPatternToken: "GET",
      ...getPatterns: string[],
      asc: "ASC",
      alpha: "ALPHA",
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9938
sort_ro(
    ...args: [
        key: RedisKey,
        byPatternToken: "BY",
        byPattern: string,
        limitToken: "LIMIT",
        offset: string
        | number,
        count: string | number,
        getPatternToken: "GET",
        ...getPatterns: string[],
        desc: "DESC",
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      byPatternToken: "BY",
      byPattern: string,
      limitToken: "LIMIT",
      offset: string
      | number,
      count: string | number,
      getPatternToken: "GET",
      ...getPatterns: string[],
      desc: "DESC",
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9952
sort_ro(
    ...args: [
        key: RedisKey,
        byPatternToken: "BY",
        byPattern: string,
        limitToken: "LIMIT",
        offset: string
        | number,
        count: string | number,
        getPatternToken: "GET",
        ...getPatterns: string[],
        desc: "DESC",
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      byPatternToken: "BY",
      byPattern: string,
      limitToken: "LIMIT",
      offset: string
      | number,
      count: string | number,
      getPatternToken: "GET",
      ...getPatterns: string[],
      desc: "DESC",
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9966
sort_ro(
    ...args: [
        key: RedisKey,
        byPatternToken: "BY",
        byPattern: string,
        limitToken: "LIMIT",
        offset: string
        | number,
        count: string | number,
        getPatternToken: "GET",
        ...getPatterns: string[],
        desc: "DESC",
        alpha: "ALPHA",
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      byPatternToken: "BY",
      byPattern: string,
      limitToken: "LIMIT",
      offset: string
      | number,
      count: string | number,
      getPatternToken: "GET",
      ...getPatterns: string[],
      desc: "DESC",
      alpha: "ALPHA",
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9979
sort_ro(
    ...args: [
        key: RedisKey,
        byPatternToken: "BY",
        byPattern: string,
        limitToken: "LIMIT",
        offset: string
        | number,
        count: string | number,
        getPatternToken: "GET",
        ...getPatterns: string[],
        desc: "DESC",
        alpha: "ALPHA",
    ],
): Promise<unknown>
Parameters
- ...args: [
      key: RedisKey,
      byPatternToken: "BY",
      byPattern: string,
      limitToken: "LIMIT",
      offset: string
      | number,
      count: string | number,
      getPatternToken: "GET",
      ...getPatterns: string[],
      desc: "DESC",
      alpha: "ALPHA",
  ]
Returns Promise<unknown>
Inherited from Commander.sort_ro
- Defined in utils/RedisCommander.ts:9994

spop

spop(key: RedisKey, callback?: Callback<string>): Promise<string>
Returns one or more random members from a set after removing them. Deletes the set if the last member was popped.
- group: set
- complexity: Without the count argument O(1), otherwise O(N) where N is the value of the passed count.
- since: 1.0.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.spop
- Defined in utils/RedisCommander.ts:10015
spop(
    key: RedisKey,
    count: string | number,
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- count: string | number
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.spop
- Defined in utils/RedisCommander.ts:10023

spopBuffer

spopBuffer(key: RedisKey, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
- key: RedisKey
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.spopBuffer
- Defined in utils/RedisCommander.ts:10019
spopBuffer(
    key: RedisKey,
    count: string | number,
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- count: string | number
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.spopBuffer
- Defined in utils/RedisCommander.ts:10028

spublish

spublish(
    shardchannel: string | Buffer,
    message: string | Buffer,
    callback?: Callback<unknown>,
): Promise<unknown>
Post a message to a shard channel
- group: pubsub
- complexity: O(N) where N is the number of clients subscribed to the receiving shard channel.
- since: 7.0.0
Parameters
- shardchannel: string | Buffer
- message: string | Buffer
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.spublish
- Defined in utils/RedisCommander.ts:10040

srandmember

srandmember(key: RedisKey, callback?: Callback<string>): Promise<string>
Get one or multiple random members from a set
- group: set
- complexity: Without the count argument O(1), otherwise O(N) where N is the absolute value of the passed count.
- since: 1.0.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.srandmember
- Defined in utils/RedisCommander.ts:10052
srandmember(
    key: RedisKey,
    count: string | number,
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- count: string | number
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.srandmember
- Defined in utils/RedisCommander.ts:10060

srandmemberBuffer

srandmemberBuffer(key: RedisKey, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
- key: RedisKey
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.srandmemberBuffer
- Defined in utils/RedisCommander.ts:10056
srandmemberBuffer(
    key: RedisKey,
    count: string | number,
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- count: string | number
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.srandmemberBuffer
- Defined in utils/RedisCommander.ts:10065

srem

srem(
    ...args: [
        key: RedisKey,
        ...members: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Removes one or more members from a set. Deletes the set if the last member was removed.
- group: set
- complexity: O(N) where N is the number of members to be removed.
- since: 1.0.0
Parameters
- ...args: [
      key: RedisKey,
      ...members: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.srem
- Defined in utils/RedisCommander.ts:10077
srem(
    ...args: [
        key: RedisKey,
        members: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      key: RedisKey,
      members: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.srem
- Defined in utils/RedisCommander.ts:10084
srem(
...args: [key: RedisKey, ...members: (string | number | Buffer)[]],
): Promise<number>
Parameters
- ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.srem
- Defined in utils/RedisCommander.ts:10091
srem(
...args: [key: RedisKey, members: (string | number | Buffer)[]],
): Promise<number>
Parameters
- ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.srem
- Defined in utils/RedisCommander.ts:10094

sscan

sscan(
    key: RedisKey,
    cursor: string | number,
    callback?: Callback<[cursor: string, elements: string[]]>,
): Promise<[cursor: string, elements: string[]]>
Iterates over members of a set.
- group: set
- complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection.
- since: 2.8.0
Parameters
- key: RedisKey
- cursor: string | number
- Optionalcallback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Inherited from Commander.sscan
- Defined in utils/RedisCommander.ts:10104
sscan(
    key: RedisKey,
    cursor: string | number,
    countToken: "COUNT",
    count: string | number,
    callback?: Callback<[cursor: string, elements: string[]]>,
): Promise<[cursor: string, elements: string[]]>
Parameters
- key: RedisKey
- cursor: string | number
- countToken: "COUNT"
- count: string | number
- Optionalcallback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Inherited from Commander.sscan
- Defined in utils/RedisCommander.ts:10114
sscan(
    key: RedisKey,
    cursor: string | number,
    patternToken: "MATCH",
    pattern: string,
    callback?: Callback<[cursor: string, elements: string[]]>,
): Promise<[cursor: string, elements: string[]]>
Parameters
- key: RedisKey
- cursor: string | number
- patternToken: "MATCH"
- pattern: string
- Optionalcallback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Inherited from Commander.sscan
- Defined in utils/RedisCommander.ts:10128
sscan(
    key: RedisKey,
    cursor: string | number,
    patternToken: "MATCH",
    pattern: string,
    countToken: "COUNT",
    count: string | number,
    callback?: Callback<[cursor: string, elements: string[]]>,
): Promise<[cursor: string, elements: string[]]>
Parameters
- key: RedisKey
- cursor: string | number
- patternToken: "MATCH"
- pattern: string
- countToken: "COUNT"
- count: string | number
- Optionalcallback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Inherited from Commander.sscan
- Defined in utils/RedisCommander.ts:10142

sscanBuffer

sscanBuffer(
    key: RedisKey,
    cursor: string | number,
    callback?: Callback<[cursor: Buffer, elements: Buffer[]]>,
): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
- key: RedisKey
- cursor: string | number
- Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Inherited from Commander.sscanBuffer
- Defined in utils/RedisCommander.ts:10109
sscanBuffer(
    key: RedisKey,
    cursor: string | number,
    countToken: "COUNT",
    count: string | number,
    callback?: Callback<[cursor: Buffer, elements: Buffer[]]>,
): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
- key: RedisKey
- cursor: string | number
- countToken: "COUNT"
- count: string | number
- Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Inherited from Commander.sscanBuffer
- Defined in utils/RedisCommander.ts:10121
sscanBuffer(
    key: RedisKey,
    cursor: string | number,
    patternToken: "MATCH",
    pattern: string,
    callback?: Callback<[cursor: Buffer, elements: Buffer[]]>,
): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
- key: RedisKey
- cursor: string | number
- patternToken: "MATCH"
- pattern: string
- Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Inherited from Commander.sscanBuffer
- Defined in utils/RedisCommander.ts:10135
sscanBuffer(
    key: RedisKey,
    cursor: string | number,
    patternToken: "MATCH",
    pattern: string,
    countToken: "COUNT",
    count: string | number,
    callback?: Callback<[cursor: Buffer, elements: Buffer[]]>,
): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
- key: RedisKey
- cursor: string | number
- patternToken: "MATCH"
- pattern: string
- countToken: "COUNT"
- count: string | number
- Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Inherited from Commander.sscanBuffer
- Defined in utils/RedisCommander.ts:10151

sscanBufferStream

sscanBufferStream(key: string, options?: ScanStreamOptions): ScanStream
Parameters
- key: string
- Optionaloptions: ScanStreamOptions
Returns ScanStream
- Defined in cluster/index.ts:621

sscanStream

sscanStream(key: string, options?: ScanStreamOptions): ScanStream
Parameters
- key: string
- Optionaloptions: ScanStreamOptions
Returns ScanStream
- Defined in cluster/index.ts:617

ssubscribe

ssubscribe(
    ...args: [
        ...shardchannels: (string | Buffer)[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Listens for messages published to shard channels.
- group: pubsub
- complexity: O(N) where N is the number of shard channels to subscribe to.
- since: 7.0.0
Parameters
- ...args: [...shardchannels: (string | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Inherited from Commander.ssubscribe
- Defined in utils/RedisCommander.ts:10167
ssubscribe(...args: (string | Buffer)[]): Promise<unknown>
Parameters
- ...args: (string | Buffer)[]
Returns Promise<unknown>
Inherited from Commander.ssubscribe
- Defined in utils/RedisCommander.ts:10173

strlen

strlen(key: RedisKey, callback?: Callback<number>): Promise<number>
Returns the length of a string value.
- group: string
- complexity: O(1)
- since: 2.2.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.strlen
- Defined in utils/RedisCommander.ts:10183

subscribe(
...args: [...channels: (string | Buffer)[], callback: Callback<unknown>],
): Promise<unknown>
Listens for messages published to channels.
- group: pubsub
- complexity: O(N) where N is the number of channels to subscribe to.
- since: 2.0.0
Parameters
- ...args: [...channels: (string | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Inherited from Commander.subscribe
- Defined in utils/RedisCommander.ts:10191
subscribe(...args: (string | Buffer)[]): Promise<unknown>
Parameters
- ...args: (string | Buffer)[]
Returns Promise<unknown>
Inherited from Commander.subscribe
- Defined in utils/RedisCommander.ts:10194

substr

substr(
    key: RedisKey,
    start: string | number,
    end: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Returns a substring from a string value.
- group: string
- complexity: O(N) where N is the length of the returned string. The complexity is ultimately determined by the returned length, but because creating a substring from an existing string is very cheap, it can be considered O(1) for small strings.
- since: 1.0.0
Parameters
- key: RedisKey
- start: string | number
- end: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.substr
- Defined in utils/RedisCommander.ts:10204

sunion

sunion(
...args: [...keys: RedisKey[], callback: Callback<string[]>],
): Promise<string[]>
Returns the union of multiple sets.
- group: set
- complexity: O(N) where N is the total number of elements in all given sets.
- since: 1.0.0
Parameters
- ...args: [...keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Inherited from Commander.sunion
- Defined in utils/RedisCommander.ts:10217
sunion(
...args: [keys: RedisKey[], callback: Callback<string[]>],
): Promise<string[]>
Parameters
- ...args: [keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Inherited from Commander.sunion
- Defined in utils/RedisCommander.ts:10223
sunion(...args: RedisKey[]): Promise<string[]>
Parameters
- ...args: RedisKey[]
Returns Promise<string[]>
Inherited from Commander.sunion
- Defined in utils/RedisCommander.ts:10229
sunion(...args: [keys: RedisKey[]]): Promise<string[]>
Parameters
- ...args: [keys: RedisKey[]]
Returns Promise<string[]>
Inherited from Commander.sunion
- Defined in utils/RedisCommander.ts:10231

sunionBuffer

sunionBuffer(
...args: [...keys: RedisKey[], callback: Callback<Buffer[]>],
): Promise<Buffer[]>
Parameters
- ...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Inherited from Commander.sunionBuffer
- Defined in utils/RedisCommander.ts:10220
sunionBuffer(
...args: [keys: RedisKey[], callback: Callback<Buffer[]>],
): Promise<Buffer[]>
Parameters
- ...args: [keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Inherited from Commander.sunionBuffer
- Defined in utils/RedisCommander.ts:10226
sunionBuffer(...args: RedisKey[]): Promise<Buffer[]>
Parameters
- ...args: RedisKey[]
Returns Promise<Buffer[]>
Inherited from Commander.sunionBuffer
- Defined in utils/RedisCommander.ts:10230
sunionBuffer(...args: [keys: RedisKey[]]): Promise<Buffer[]>
Parameters
- ...args: [keys: RedisKey[]]
Returns Promise<Buffer[]>
Inherited from Commander.sunionBuffer
- Defined in utils/RedisCommander.ts:10232

sunionstore

sunionstore(
    ...args: [
        destination: RedisKey,
        ...keys: RedisKey[],
        callback: Callback<number>,
    ],
): Promise<number>
Stores the union of multiple sets in a key.
- group: set
- complexity: O(N) where N is the total number of elements in all given sets.
- since: 1.0.0
Parameters
- ...args: [destination: RedisKey, ...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Inherited from Commander.sunionstore
- Defined in utils/RedisCommander.ts:10240
sunionstore(
    ...args: [
        destination: RedisKey,
        keys: RedisKey[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [destination: RedisKey, keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Inherited from Commander.sunionstore
- Defined in utils/RedisCommander.ts:10247
sunionstore(
...args: [destination: RedisKey, ...keys: RedisKey[]],
): Promise<number>
Parameters
- ...args: [destination: RedisKey, ...keys: RedisKey[]]
Returns Promise<number>
Inherited from Commander.sunionstore
- Defined in utils/RedisCommander.ts:10254
sunionstore(...args: [destination: RedisKey, keys: RedisKey[]]): Promise<number>
Parameters
- ...args: [destination: RedisKey, keys: RedisKey[]]
Returns Promise<number>
Inherited from Commander.sunionstore
- Defined in utils/RedisCommander.ts:10257

sunsubscribe

sunsubscribe(callback?: Callback<unknown>): Promise<unknown>
Stops listening to messages posted to shard channels.
- group: pubsub
- complexity: O(N) where N is the number of shard channels to unsubscribe.
- since: 7.0.0
Parameters
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.sunsubscribe
- Defined in utils/RedisCommander.ts:10267
sunsubscribe(
    ...args: [
        ...shardchannels: (string | Buffer)[],
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [...shardchannels: (string | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Inherited from Commander.sunsubscribe
- Defined in utils/RedisCommander.ts:10268
sunsubscribe(...args: (string | Buffer)[]): Promise<unknown>
Parameters
- ...args: (string | Buffer)[]
Returns Promise<unknown>
Inherited from Commander.sunsubscribe
- Defined in utils/RedisCommander.ts:10274

swapdb

swapdb(
    index1: string | number,
    index2: string | number,
    callback?: Callback<"OK">,
): Promise<"OK">
Swaps two databases.
- group: server
- complexity: O(N) where N is the count of clients watching or blocking on keys from both databases.
- since: 4.0.0
Parameters
- index1: string | number
- index2: string | number
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.swapdb
- Defined in utils/RedisCommander.ts:10284

sync

sync(callback?: Callback<unknown>): Promise<unknown>
An internal command used in replication.
- group: server
- complexity: undefined
- since: 1.0.0
Parameters
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.sync
- Defined in utils/RedisCommander.ts:10296

time

time(callback?: Callback<number[]>): Promise<number[]>
Returns the server time.
- group: server
- complexity: O(1)
- since: 2.6.0
Parameters
- Optionalcallback: Callback<number[]>
Returns Promise<number[]>
Inherited from Commander.time
- Defined in utils/RedisCommander.ts:10304

touch

touch(
...args: [...keys: RedisKey[], callback: Callback<number>],
): Promise<number>
Returns the number of existing keys out of those specified after updating the time they were last accessed.
- group: generic
- complexity: O(N) where N is the number of keys that will be touched.
- since: 3.2.1
Parameters
- ...args: [...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Inherited from Commander.touch
- Defined in utils/RedisCommander.ts:10312
touch(...args: [keys: RedisKey[], callback: Callback<number>]): Promise<number>
Parameters
- ...args: [keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Inherited from Commander.touch
- Defined in utils/RedisCommander.ts:10315
touch(...args: RedisKey[]): Promise<number>
Parameters
- ...args: RedisKey[]
Returns Promise<number>
Inherited from Commander.touch
- Defined in utils/RedisCommander.ts:10318
touch(...args: [keys: RedisKey[]]): Promise<number>
Parameters
- ...args: [keys: RedisKey[]]
Returns Promise<number>
Inherited from Commander.touch
- Defined in utils/RedisCommander.ts:10319

ttl

ttl(key: RedisKey, callback?: Callback<number>): Promise<number>
Returns the expiration time in seconds of a key.
- group: generic
- complexity: O(1)
- since: 1.0.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.ttl
- Defined in utils/RedisCommander.ts:10327

type

type(key: RedisKey, callback?: Callback<string>): Promise<string>
Determines the type of value stored at a key.
- group: generic
- complexity: O(1)
- since: 1.0.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.type
- Defined in utils/RedisCommander.ts:10335

unlink

unlink(
...args: [...keys: RedisKey[], callback: Callback<number>],
): Promise<number>
Asynchronously deletes one or more keys.
- group: generic
- complexity: O(1) for each key removed regardless of its size. Then the command does O(N) work in a different thread in order to reclaim memory, where N is the number of allocations the deleted objects where composed of.
- since: 4.0.0
Parameters
- ...args: [...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Inherited from Commander.unlink
- Defined in utils/RedisCommander.ts:10343
unlink(...args: [keys: RedisKey[], callback: Callback<number>]): Promise<number>
Parameters
- ...args: [keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Inherited from Commander.unlink
- Defined in utils/RedisCommander.ts:10346
unlink(...args: RedisKey[]): Promise<number>
Parameters
- ...args: RedisKey[]
Returns Promise<number>
Inherited from Commander.unlink
- Defined in utils/RedisCommander.ts:10349
unlink(...args: [keys: RedisKey[]]): Promise<number>
Parameters
- ...args: [keys: RedisKey[]]
Returns Promise<number>
Inherited from Commander.unlink
- Defined in utils/RedisCommander.ts:10350

unsubscribe

unsubscribe(callback?: Callback<unknown>): Promise<unknown>
Stops listening to messages posted to channels.
- group: pubsub
- complexity: O(N) where N is the number of channels to unsubscribe.
- since: 2.0.0
Parameters
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.unsubscribe
- Defined in utils/RedisCommander.ts:10358
unsubscribe(
...args: [...channels: (string | Buffer)[], callback: Callback<unknown>],
): Promise<unknown>
Parameters
- ...args: [...channels: (string | Buffer)[], callback: Callback<unknown>]
Returns Promise<unknown>
Inherited from Commander.unsubscribe
- Defined in utils/RedisCommander.ts:10359
unsubscribe(...args: (string | Buffer)[]): Promise<unknown>
Parameters
- ...args: (string | Buffer)[]
Returns Promise<unknown>
Inherited from Commander.unsubscribe
- Defined in utils/RedisCommander.ts:10362

unwatch

unwatch(callback?: Callback<"OK">): Promise<"OK">
Forgets about watched keys of a transaction.
- group: transactions
- complexity: O(1)
- since: 2.2.0
Parameters
- Optionalcallback: Callback<"OK">
Returns Promise<"OK">
Inherited from Commander.unwatch
- Defined in utils/RedisCommander.ts:10372

wait

wait(
    numreplicas: string | number,
    timeout: string | number,
    callback?: Callback<number>,
): Promise<number>
Blocks until the asynchronous replication of all preceding write commands sent by the connection is completed.
- group: generic
- complexity: O(1)
- since: 3.0.0
Parameters
- numreplicas: string | number
- timeout: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.wait
- Defined in utils/RedisCommander.ts:10380

waitaof

waitaof(
    numlocal: string | number,
    numreplicas: string | number,
    timeout: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Blocks until all of the preceding write commands sent by the connection are written to the append-only file of the primary and/or replicas.
- group: generic
- complexity: O(1)
- since: 7.2.0
Parameters
- numlocal: string | number
- numreplicas: string | number
- timeout: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.waitaof
- Defined in utils/RedisCommander.ts:10392

watch

watch(...args: [...keys: RedisKey[], callback: Callback<"OK">]): Promise<"OK">
Monitors changes to keys to determine the execution of a transaction.
- group: transactions
- complexity: O(1) for every key.
- since: 2.2.0
Parameters
- ...args: [...keys: RedisKey[], callback: Callback<"OK">]
Returns Promise<"OK">
Inherited from Commander.watch
- Defined in utils/RedisCommander.ts:10405
watch(...args: [keys: RedisKey[], callback: Callback<"OK">]): Promise<"OK">
Parameters
- ...args: [keys: RedisKey[], callback: Callback<"OK">]
Returns Promise<"OK">
Inherited from Commander.watch
- Defined in utils/RedisCommander.ts:10408
watch(...args: RedisKey[]): Promise<"OK">
Parameters
- ...args: RedisKey[]
Returns Promise<"OK">
Inherited from Commander.watch
- Defined in utils/RedisCommander.ts:10411
watch(...args: [keys: RedisKey[]]): Promise<"OK">
Parameters
- ...args: [keys: RedisKey[]]
Returns Promise<"OK">
Inherited from Commander.watch
- Defined in utils/RedisCommander.ts:10412

xack

xack(
    ...args: [
        key: RedisKey,
        group: string
        | Buffer,
        ...ids: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Returns the number of messages that were successfully acknowledged by the consumer group member of a stream.
- group: stream
- complexity: O(1) for each message ID processed.
- since: 5.0.0
Parameters
- ...args: [
      key: RedisKey,
      group: string
      | Buffer,
      ...ids: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.xack
- Defined in utils/RedisCommander.ts:10420
xack(
    ...args: [
        key: RedisKey,
        group: string
        | Buffer,
        ...ids: (string | number | Buffer)[],
    ],
): Promise<number>
Parameters
- ...args: [key: RedisKey, group: string | Buffer, ...ids: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.xack
- Defined in utils/RedisCommander.ts:10428

xadd

xadd(
    ...args: [
        key: RedisKey,
        ...args: RedisValue[],
        callback: Callback<string>,
    ],
): Promise<string>
Appends a new message to a stream. Creates the key if it doesn't exist.
- group: stream
- complexity: O(1) when adding a new entry, O(N) when trimming where N being the number of entries evicted.
- since: 5.0.0
Parameters
- ...args: [key: RedisKey, ...args: RedisValue[], callback: Callback<string>]
Returns Promise<string>
Inherited from Commander.xadd
- Defined in utils/RedisCommander.ts:10442
xadd(...args: [key: RedisKey, ...args: RedisValue[]]): Promise<string>
Parameters
- ...args: [key: RedisKey, ...args: RedisValue[]]
Returns Promise<string>
Inherited from Commander.xadd
- Defined in utils/RedisCommander.ts:10456

xaddBuffer

xaddBuffer(
    ...args: [
        key: RedisKey,
        ...args: RedisValue[],
        callback: Callback<Buffer>,
    ],
): Promise<Buffer>
Parameters
- ...args: [key: RedisKey, ...args: RedisValue[], callback: Callback<Buffer>]
Returns Promise<Buffer>
Inherited from Commander.xaddBuffer
- Defined in utils/RedisCommander.ts:10449
xaddBuffer(...args: [key: RedisKey, ...args: RedisValue[]]): Promise<Buffer>
Parameters
- ...args: [key: RedisKey, ...args: RedisValue[]]
Returns Promise<Buffer>
Inherited from Commander.xaddBuffer
- Defined in utils/RedisCommander.ts:10459

xautoclaim

xautoclaim(
    key: RedisKey,
    group: string | Buffer,
    consumer: string | Buffer,
    minIdleTime: string | number | Buffer,
    start: string | number | Buffer,
    callback?: Callback<unknown[]>,
): Promise<unknown[]>
Changes, or acquires, ownership of messages in a consumer group, as if the messages were delivered to as consumer group member.
- group: stream
- complexity: O(1) if COUNT is small.
- since: 6.2.0
Parameters
- key: RedisKey
- group: string | Buffer
- consumer: string | Buffer
- minIdleTime: string | number | Buffer
- start: string | number | Buffer
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.xautoclaim
- Defined in utils/RedisCommander.ts:10469
xautoclaim(
    key: RedisKey,
    group: string | Buffer,
    consumer: string | Buffer,
    minIdleTime: string | number | Buffer,
    start: string | number | Buffer,
    justid: "JUSTID",
    callback?: Callback<unknown[]>,
): Promise<unknown[]>
Parameters
- key: RedisKey
- group: string | Buffer
- consumer: string | Buffer
- minIdleTime: string | number | Buffer
- start: string | number | Buffer
- justid: "JUSTID"
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.xautoclaim
- Defined in utils/RedisCommander.ts:10477
xautoclaim(
    key: RedisKey,
    group: string | Buffer,
    consumer: string | Buffer,
    minIdleTime: string | number | Buffer,
    start: string | number | Buffer,
    countToken: "COUNT",
    count: string | number,
    callback?: Callback<unknown[]>,
): Promise<unknown[]>
Parameters
- key: RedisKey
- group: string | Buffer
- consumer: string | Buffer
- minIdleTime: string | number | Buffer
- start: string | number | Buffer
- countToken: "COUNT"
- count: string | number
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.xautoclaim
- Defined in utils/RedisCommander.ts:10486
xautoclaim(
    key: RedisKey,
    group: string | Buffer,
    consumer: string | Buffer,
    minIdleTime: string | number | Buffer,
    start: string | number | Buffer,
    countToken: "COUNT",
    count: string | number,
    justid: "JUSTID",
    callback?: Callback<unknown[]>,
): Promise<unknown[]>
Parameters
- key: RedisKey
- group: string | Buffer
- consumer: string | Buffer
- minIdleTime: string | number | Buffer
- start: string | number | Buffer
- countToken: "COUNT"
- count: string | number
- justid: "JUSTID"
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.xautoclaim
- Defined in utils/RedisCommander.ts:10496

xclaim

xclaim(
    ...args: [
        key: RedisKey,
        group: string
        | Buffer,
        consumer: string | Buffer,
        minIdleTime: string | number | Buffer,
        ...args: RedisValue[],
        callback: Callback<unknown[]>,
    ],
): Promise<unknown[]>
Changes, or acquires, ownership of a message in a consumer group, as if the message was delivered a consumer group member.
- group: stream
- complexity: O(log N) with N being the number of messages in the PEL of the consumer group.
- since: 5.0.0
Parameters
- ...args: [
      key: RedisKey,
      group: string
      | Buffer,
      consumer: string | Buffer,
      minIdleTime: string | number | Buffer,
      ...args: RedisValue[],
      callback: Callback<unknown[]>,
  ]
Returns Promise<unknown[]>
Inherited from Commander.xclaim
- Defined in utils/RedisCommander.ts:10514
xclaim(
    ...args: [
        key: RedisKey,
        group: string
        | Buffer,
        consumer: string | Buffer,
        minIdleTime: string | number | Buffer,
        ...args: RedisValue[],
    ],
): Promise<unknown[]>
Parameters
- ...args: [
      key: RedisKey,
      group: string
      | Buffer,
      consumer: string | Buffer,
      minIdleTime: string | number | Buffer,
      ...args: RedisValue[],
  ]
Returns Promise<unknown[]>
Inherited from Commander.xclaim
- Defined in utils/RedisCommander.ts:10524

xdel

xdel(
    ...args: [
        key: RedisKey,
        ...ids: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Returns the number of messages after removing them from a stream.
- group: stream
- complexity: O(1) for each single item to delete in the stream, regardless of the stream size.
- since: 5.0.0
Parameters
- ...args: [
      key: RedisKey,
      ...ids: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.xdel
- Defined in utils/RedisCommander.ts:10540
xdel(
...args: [key: RedisKey, ...ids: (string | number | Buffer)[]],
): Promise<number>
Parameters
- ...args: [key: RedisKey, ...ids: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.xdel
- Defined in utils/RedisCommander.ts:10547

xgroup

xgroup(
    subcommand: "CREATE",
    key: RedisKey,
    group: string | Buffer,
    id: string | number | Buffer,
    callback?: Callback<unknown>,
): Promise<unknown>
Creates a consumer group.
- group: stream
- complexity: O(1)
- since: 5.0.0
Parameters
- subcommand: "CREATE"
- key: RedisKey
- group: string | Buffer
- id: string | number | Buffer
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.xgroup
- Defined in utils/RedisCommander.ts:10557
xgroup(
    subcommand: "CREATE",
    key: RedisKey,
    group: string | Buffer,
    id: string | number | Buffer,
    entriesreadToken: "ENTRIESREAD",
    entriesread: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "CREATE"
- key: RedisKey
- group: string | Buffer
- id: string | number | Buffer
- entriesreadToken: "ENTRIESREAD"
- entriesread: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.xgroup
- Defined in utils/RedisCommander.ts:10564
xgroup(
    subcommand: "CREATE",
    key: RedisKey,
    group: string | Buffer,
    id: string | number | Buffer,
    mkstream: "MKSTREAM",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "CREATE"
- key: RedisKey
- group: string | Buffer
- id: string | number | Buffer
- mkstream: "MKSTREAM"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.xgroup
- Defined in utils/RedisCommander.ts:10573
xgroup(
    subcommand: "CREATE",
    key: RedisKey,
    group: string | Buffer,
    id: string | number | Buffer,
    mkstream: "MKSTREAM",
    entriesreadToken: "ENTRIESREAD",
    entriesread: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "CREATE"
- key: RedisKey
- group: string | Buffer
- id: string | number | Buffer
- mkstream: "MKSTREAM"
- entriesreadToken: "ENTRIESREAD"
- entriesread: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.xgroup
- Defined in utils/RedisCommander.ts:10581
xgroup(
    subcommand: "CREATE",
    key: RedisKey,
    group: string | Buffer,
    newId: "$",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "CREATE"
- key: RedisKey
- group: string | Buffer
- newId: "$"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.xgroup
- Defined in utils/RedisCommander.ts:10591
xgroup(
    subcommand: "CREATE",
    key: RedisKey,
    group: string | Buffer,
    newId: "$",
    entriesreadToken: "ENTRIESREAD",
    entriesread: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "CREATE"
- key: RedisKey
- group: string | Buffer
- newId: "$"
- entriesreadToken: "ENTRIESREAD"
- entriesread: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.xgroup
- Defined in utils/RedisCommander.ts:10598
xgroup(
    subcommand: "CREATE",
    key: RedisKey,
    group: string | Buffer,
    newId: "$",
    mkstream: "MKSTREAM",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "CREATE"
- key: RedisKey
- group: string | Buffer
- newId: "$"
- mkstream: "MKSTREAM"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.xgroup
- Defined in utils/RedisCommander.ts:10607
xgroup(
    subcommand: "CREATE",
    key: RedisKey,
    group: string | Buffer,
    newId: "$",
    mkstream: "MKSTREAM",
    entriesreadToken: "ENTRIESREAD",
    entriesread: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "CREATE"
- key: RedisKey
- group: string | Buffer
- newId: "$"
- mkstream: "MKSTREAM"
- entriesreadToken: "ENTRIESREAD"
- entriesread: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.xgroup
- Defined in utils/RedisCommander.ts:10615
xgroup(
    subcommand: "CREATECONSUMER",
    key: RedisKey,
    group: string | Buffer,
    consumer: string | Buffer,
    callback?: Callback<unknown>,
): Promise<unknown>
Creates a consumer in a consumer group.
- group: stream
- complexity: O(1)
- since: 6.2.0
Parameters
- subcommand: "CREATECONSUMER"
- key: RedisKey
- group: string | Buffer
- consumer: string | Buffer
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.xgroup
- Defined in utils/RedisCommander.ts:10632
xgroup(
    subcommand: "DELCONSUMER",
    key: RedisKey,
    group: string | Buffer,
    consumer: string | Buffer,
    callback?: Callback<unknown>,
): Promise<unknown>
Deletes a consumer from a consumer group.
- group: stream
- complexity: O(1)
- since: 5.0.0
Parameters
- subcommand: "DELCONSUMER"
- key: RedisKey
- group: string | Buffer
- consumer: string | Buffer
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.xgroup
- Defined in utils/RedisCommander.ts:10646
xgroup(
    subcommand: "DESTROY",
    key: RedisKey,
    group: string | Buffer,
    callback?: Callback<unknown>,
): Promise<unknown>
Destroys a consumer group.
- group: stream
- complexity: O(N) where N is the number of entries in the group's pending entries list (PEL).
- since: 5.0.0
Parameters
- subcommand: "DESTROY"
- key: RedisKey
- group: string | Buffer
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.xgroup
- Defined in utils/RedisCommander.ts:10660
xgroup(subcommand: "HELP", callback?: Callback<unknown>): Promise<unknown>
Returns helpful text about the different subcommands.
- group: stream
- complexity: O(1)
- since: 5.0.0
Parameters
- subcommand: "HELP"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.xgroup
- Defined in utils/RedisCommander.ts:10673
xgroup(
    subcommand: "SETID",
    key: RedisKey,
    group: string | Buffer,
    id: string | number | Buffer,
    callback?: Callback<unknown>,
): Promise<unknown>
Sets the last-delivered ID of a consumer group.
- group: stream
- complexity: O(1)
- since: 5.0.0
Parameters
- subcommand: "SETID"
- key: RedisKey
- group: string | Buffer
- id: string | number | Buffer
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.xgroup
- Defined in utils/RedisCommander.ts:10684
xgroup(
    subcommand: "SETID",
    key: RedisKey,
    group: string | Buffer,
    id: string | number | Buffer,
    entriesreadToken: "ENTRIESREAD",
    entriesread: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "SETID"
- key: RedisKey
- group: string | Buffer
- id: string | number | Buffer
- entriesreadToken: "ENTRIESREAD"
- entriesread: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.xgroup
- Defined in utils/RedisCommander.ts:10691
xgroup(
    subcommand: "SETID",
    key: RedisKey,
    group: string | Buffer,
    newId: "$",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "SETID"
- key: RedisKey
- group: string | Buffer
- newId: "$"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.xgroup
- Defined in utils/RedisCommander.ts:10700
xgroup(
    subcommand: "SETID",
    key: RedisKey,
    group: string | Buffer,
    newId: "$",
    entriesreadToken: "ENTRIESREAD",
    entriesread: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "SETID"
- key: RedisKey
- group: string | Buffer
- newId: "$"
- entriesreadToken: "ENTRIESREAD"
- entriesread: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.xgroup
- Defined in utils/RedisCommander.ts:10707

xinfo

xinfo(
    subcommand: "CONSUMERS",
    key: RedisKey,
    group: string | Buffer,
    callback?: Callback<unknown>,
): Promise<unknown>
Returns a list of the consumers in a consumer group.
- group: stream
- complexity: O(1)
- since: 5.0.0
Parameters
- subcommand: "CONSUMERS"
- key: RedisKey
- group: string | Buffer
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.xinfo
- Defined in utils/RedisCommander.ts:10723
xinfo(
    subcommand: "GROUPS",
    key: RedisKey,
    callback?: Callback<unknown>,
): Promise<unknown>
Returns a list of the consumer groups of a stream.
- group: stream
- complexity: O(1)
- since: 5.0.0
Parameters
- subcommand: "GROUPS"
- key: RedisKey
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.xinfo
- Defined in utils/RedisCommander.ts:10736
xinfo(subcommand: "HELP", callback?: Callback<unknown>): Promise<unknown>
Returns helpful text about the different subcommands.
- group: stream
- complexity: O(1)
- since: 5.0.0
Parameters
- subcommand: "HELP"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.xinfo
- Defined in utils/RedisCommander.ts:10748
xinfo(
    subcommand: "STREAM",
    key: RedisKey,
    callback?: Callback<unknown>,
): Promise<unknown>
Returns information about a stream.
- group: stream
- complexity: O(1)
- since: 5.0.0
Parameters
- subcommand: "STREAM"
- key: RedisKey
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.xinfo
- Defined in utils/RedisCommander.ts:10759
xinfo(
    subcommand: "STREAM",
    key: RedisKey,
    full: "FULL",
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "STREAM"
- key: RedisKey
- full: "FULL"
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.xinfo
- Defined in utils/RedisCommander.ts:10764
xinfo(
    subcommand: "STREAM",
    key: RedisKey,
    full: "FULL",
    countToken: "COUNT",
    count: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- subcommand: "STREAM"
- key: RedisKey
- full: "FULL"
- countToken: "COUNT"
- count: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.xinfo
- Defined in utils/RedisCommander.ts:10770

xlen

xlen(key: RedisKey, callback?: Callback<number>): Promise<number>
Return the number of messages in a stream.
- group: stream
- complexity: O(1)
- since: 5.0.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.xlen
- Defined in utils/RedisCommander.ts:10785

xpending

xpending(
    key: RedisKey,
    group: string | Buffer,
    callback?: Callback<unknown[]>,
): Promise<unknown[]>
Returns the information and entries from a stream consumer group's pending entries list.
- group: stream
- complexity: O(N) with N being the number of elements returned, so asking for a small fixed number of entries per call is O(1). O(M), where M is the total number of entries scanned when used with the IDLE filter. When the command returns just the summary and the list of consumers is small, it runs in O(1) time; otherwise, an additional O(N) time for iterating every consumer.
- since: 5.0.0
Parameters
- key: RedisKey
- group: string | Buffer
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.xpending
- Defined in utils/RedisCommander.ts:10793
xpending(
    key: RedisKey,
    group: string | Buffer,
    start: string | number | Buffer,
    end: string | number | Buffer,
    count: string | number,
    callback?: Callback<unknown[]>,
): Promise<unknown[]>
Parameters
- key: RedisKey
- group: string | Buffer
- start: string | number | Buffer
- end: string | number | Buffer
- count: string | number
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.xpending
- Defined in utils/RedisCommander.ts:10798
xpending(
    key: RedisKey,
    group: string | Buffer,
    start: string | number | Buffer,
    end: string | number | Buffer,
    count: string | number,
    consumer: string | Buffer,
    callback?: Callback<unknown[]>,
): Promise<unknown[]>
Parameters
- key: RedisKey
- group: string | Buffer
- start: string | number | Buffer
- end: string | number | Buffer
- count: string | number
- consumer: string | Buffer
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.xpending
- Defined in utils/RedisCommander.ts:10806
xpending(
    key: RedisKey,
    group: string | Buffer,
    minIdleTimeToken: "IDLE",
    minIdleTime: string | number,
    start: string | number | Buffer,
    end: string | number | Buffer,
    count: string | number,
    callback?: Callback<unknown[]>,
): Promise<unknown[]>
Parameters
- key: RedisKey
- group: string | Buffer
- minIdleTimeToken: "IDLE"
- minIdleTime: string | number
- start: string | number | Buffer
- end: string | number | Buffer
- count: string | number
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.xpending
- Defined in utils/RedisCommander.ts:10815
xpending(
    key: RedisKey,
    group: string | Buffer,
    minIdleTimeToken: "IDLE",
    minIdleTime: string | number,
    start: string | number | Buffer,
    end: string | number | Buffer,
    count: string | number,
    consumer: string | Buffer,
    callback?: Callback<unknown[]>,
): Promise<unknown[]>
Parameters
- key: RedisKey
- group: string | Buffer
- minIdleTimeToken: "IDLE"
- minIdleTime: string | number
- start: string | number | Buffer
- end: string | number | Buffer
- count: string | number
- consumer: string | Buffer
- Optionalcallback: Callback<unknown[]>
Returns Promise<unknown[]>
Inherited from Commander.xpending
- Defined in utils/RedisCommander.ts:10825

xrange

xrange(
    key: RedisKey,
    start: string | number | Buffer,
    end: string | number | Buffer,
    callback?: Callback<[id: string, fields: string[]][]>,
): Promise<[id: string, fields: string[]][]>
Returns the messages from a stream within a range of IDs.
- group: stream
- complexity: O(N) with N being the number of elements being returned. If N is constant (e.g. always asking for the first 10 elements with COUNT), you can consider it O(1).
- since: 5.0.0
Parameters
- key: RedisKey
- start: string | number | Buffer
- end: string | number | Buffer
- Optionalcallback: Callback<[id: string, fields: string[]][]>
Returns Promise<[id: string, fields: string[]][]>
Inherited from Commander.xrange
- Defined in utils/RedisCommander.ts:10843
xrange(
    key: RedisKey,
    start: string | number | Buffer,
    end: string | number | Buffer,
    countToken: "COUNT",
    count: string | number,
    callback?: Callback<[id: string, fields: string[]][]>,
): Promise<[id: string, fields: string[]][]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- end: string | number | Buffer
- countToken: "COUNT"
- count: string | number
- Optionalcallback: Callback<[id: string, fields: string[]][]>
Returns Promise<[id: string, fields: string[]][]>
Inherited from Commander.xrange
- Defined in utils/RedisCommander.ts:10855

xrangeBuffer

xrangeBuffer(
    key: RedisKey,
    start: string | number | Buffer,
    end: string | number | Buffer,
    callback?: Callback<[id: Buffer, fields: Buffer[]][]>,
): Promise<[id: Buffer, fields: Buffer[]][]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- end: string | number | Buffer
- Optionalcallback: Callback<[id: Buffer, fields: Buffer[]][]>
Returns Promise<[id: Buffer, fields: Buffer[]][]>
Inherited from Commander.xrangeBuffer
- Defined in utils/RedisCommander.ts:10849
xrangeBuffer(
    key: RedisKey,
    start: string | number | Buffer,
    end: string | number | Buffer,
    countToken: "COUNT",
    count: string | number,
    callback?: Callback<[id: Buffer, fields: Buffer[]][]>,
): Promise<[id: Buffer, fields: Buffer[]][]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- end: string | number | Buffer
- countToken: "COUNT"
- count: string | number
- Optionalcallback: Callback<[id: Buffer, fields: Buffer[]][]>
Returns Promise<[id: Buffer, fields: Buffer[]][]>
Inherited from Commander.xrangeBuffer
- Defined in utils/RedisCommander.ts:10863

xread

xread(
    ...args: [
        streamsToken: "STREAMS",
        ...args: RedisValue[],
        callback: Callback<
            [key: string, items: [id: string, fields: string[]][]][],
        >,
    ],
): Promise<[key: string, items: [id: string, fields: string[]][]][]>
Returns messages from multiple streams with IDs greater than the ones requested. Blocks until a message is available otherwise.
- group: stream
- complexity: undefined
- since: 5.0.0
Parameters
- ...args: [
      streamsToken: "STREAMS",
      ...args: RedisValue[],
      callback: Callback<
          [key: string, items: [id: string, fields: string[]][]][],
      >,
  ]
Returns Promise<[key: string, items: [id: string, fields: string[]][]][]>
Inherited from Commander.xread
- Defined in utils/RedisCommander.ts:10878
xread(
...args: [streamsToken: "STREAMS", ...args: RedisValue[]],
): Promise<[key: string, items: [id: string, fields: string[]][]][]>
Parameters
- ...args: [streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<[key: string, items: [id: string, fields: string[]][]][]>
Inherited from Commander.xread
- Defined in utils/RedisCommander.ts:10902
xread(
    ...args: [
        millisecondsToken: "BLOCK",
        milliseconds: string
        | number,
        streamsToken: "STREAMS",
        ...args: RedisValue[],
        callback: Callback<
            [key: string, items: [id: string, fields: string[]][]][],
        >,
    ],
): Promise<[key: string, items: [id: string, fields: string[]][]][]>
Parameters
- ...args: [
      millisecondsToken: "BLOCK",
      milliseconds: string
      | number,
      streamsToken: "STREAMS",
      ...args: RedisValue[],
      callback: Callback<
          [key: string, items: [id: string, fields: string[]][]][],
      >,
  ]
Returns Promise<[key: string, items: [id: string, fields: string[]][]][]>
Inherited from Commander.xread
- Defined in utils/RedisCommander.ts:10914
xread(
    ...args: [
        millisecondsToken: "BLOCK",
        milliseconds: string
        | number,
        streamsToken: "STREAMS",
        ...args: RedisValue[],
    ],
): Promise<[key: string, items: [id: string, fields: string[]][]][]>
Parameters
- ...args: [
      millisecondsToken: "BLOCK",
      milliseconds: string
      | number,
      streamsToken: "STREAMS",
      ...args: RedisValue[],
  ]
Returns Promise<[key: string, items: [id: string, fields: string[]][]][]>
Inherited from Commander.xread
- Defined in utils/RedisCommander.ts:10942
xread(
    ...args: [
        countToken: "COUNT",
        count: string
        | number,
        streamsToken: "STREAMS",
        ...args: RedisValue[],
        callback: Callback<
            [key: string, items: [id: string, fields: string[]][]][],
        >,
    ],
): Promise<[key: string, items: [id: string, fields: string[]][]][]>
Parameters
- ...args: [
      countToken: "COUNT",
      count: string
      | number,
      streamsToken: "STREAMS",
      ...args: RedisValue[],
      callback: Callback<
          [key: string, items: [id: string, fields: string[]][]][],
      >,
  ]
Returns Promise<[key: string, items: [id: string, fields: string[]][]][]>
Inherited from Commander.xread
- Defined in utils/RedisCommander.ts:10964
xread(
    ...args: [
        countToken: "COUNT",
        count: string
        | number,
        streamsToken: "STREAMS",
        ...args: RedisValue[],
    ],
): Promise<[key: string, items: [id: string, fields: string[]][]][]>
Parameters
- ...args: [
      countToken: "COUNT",
      count: string
      | number,
      streamsToken: "STREAMS",
      ...args: RedisValue[],
  ]
Returns Promise<[key: string, items: [id: string, fields: string[]][]][]>
Inherited from Commander.xread
- Defined in utils/RedisCommander.ts:10992
xread(
    ...args: [
        countToken: "COUNT",
        count: string
        | number,
        millisecondsToken: "BLOCK",
        milliseconds: string | number,
        streamsToken: "STREAMS",
        ...args: RedisValue[],
        callback: Callback<
            [key: string, items: [id: string, fields: string[]][]][],
        >,
    ],
): Promise<[key: string, items: [id: string, fields: string[]][]][]>
Parameters
- ...args: [
      countToken: "COUNT",
      count: string
      | number,
      millisecondsToken: "BLOCK",
      milliseconds: string | number,
      streamsToken: "STREAMS",
      ...args: RedisValue[],
      callback: Callback<
          [key: string, items: [id: string, fields: string[]][]][],
      >,
  ]
Returns Promise<[key: string, items: [id: string, fields: string[]][]][]>
Inherited from Commander.xread
- Defined in utils/RedisCommander.ts:11014
xread(
    ...args: [
        countToken: "COUNT",
        count: string
        | number,
        millisecondsToken: "BLOCK",
        milliseconds: string | number,
        streamsToken: "STREAMS",
        ...args: RedisValue[],
    ],
): Promise<[key: string, items: [id: string, fields: string[]][]][]>
Parameters
- ...args: [
      countToken: "COUNT",
      count: string
      | number,
      millisecondsToken: "BLOCK",
      milliseconds: string | number,
      streamsToken: "STREAMS",
      ...args: RedisValue[],
  ]
Returns Promise<[key: string, items: [id: string, fields: string[]][]][]>
Inherited from Commander.xread
- Defined in utils/RedisCommander.ts:11046

xreadBuffer

xreadBuffer(
    ...args: [
        streamsToken: "STREAMS",
        ...args: RedisValue[],
        callback: Callback<
            [key: Buffer, items: [id: Buffer, fields: Buffer[]][]][],
        >,
    ],
): Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
Parameters
- ...args: [
      streamsToken: "STREAMS",
      ...args: RedisValue[],
      callback: Callback<
          [key: Buffer, items: [id: Buffer, fields: Buffer[]][]][],
      >,
  ]
Returns Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
Inherited from Commander.xreadBuffer
- Defined in utils/RedisCommander.ts:10890
xreadBuffer(
...args: [streamsToken: "STREAMS", ...args: RedisValue[]],
): Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
Parameters
- ...args: [streamsToken: "STREAMS", ...args: RedisValue[]]
Returns Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
Inherited from Commander.xreadBuffer
- Defined in utils/RedisCommander.ts:10908
xreadBuffer(
    ...args: [
        millisecondsToken: "BLOCK",
        milliseconds: string
        | number,
        streamsToken: "STREAMS",
        ...args: RedisValue[],
        callback: Callback<
            [key: Buffer, items: [id: Buffer, fields: Buffer[]][]][],
        >,
    ],
): Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
Parameters
- ...args: [
      millisecondsToken: "BLOCK",
      milliseconds: string
      | number,
      streamsToken: "STREAMS",
      ...args: RedisValue[],
      callback: Callback<
          [key: Buffer, items: [id: Buffer, fields: Buffer[]][]][],
      >,
  ]
Returns Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
Inherited from Commander.xreadBuffer
- Defined in utils/RedisCommander.ts:10928
xreadBuffer(
    ...args: [
        millisecondsToken: "BLOCK",
        milliseconds: string
        | number,
        streamsToken: "STREAMS",
        ...args: RedisValue[],
    ],
): Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
Parameters
- ...args: [
      millisecondsToken: "BLOCK",
      milliseconds: string
      | number,
      streamsToken: "STREAMS",
      ...args: RedisValue[],
  ]
Returns Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
Inherited from Commander.xreadBuffer
- Defined in utils/RedisCommander.ts:10953
xreadBuffer(
    ...args: [
        countToken: "COUNT",
        count: string
        | number,
        streamsToken: "STREAMS",
        ...args: RedisValue[],
        callback: Callback<
            [key: Buffer, items: [id: Buffer, fields: Buffer[]][]][],
        >,
    ],
): Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
Parameters
- ...args: [
      countToken: "COUNT",
      count: string
      | number,
      streamsToken: "STREAMS",
      ...args: RedisValue[],
      callback: Callback<
          [key: Buffer, items: [id: Buffer, fields: Buffer[]][]][],
      >,
  ]
Returns Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
Inherited from Commander.xreadBuffer
- Defined in utils/RedisCommander.ts:10978
xreadBuffer(
    ...args: [
        countToken: "COUNT",
        count: string
        | number,
        streamsToken: "STREAMS",
        ...args: RedisValue[],
    ],
): Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
Parameters
- ...args: [
      countToken: "COUNT",
      count: string
      | number,
      streamsToken: "STREAMS",
      ...args: RedisValue[],
  ]
Returns Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
Inherited from Commander.xreadBuffer
- Defined in utils/RedisCommander.ts:11003
xreadBuffer(
    ...args: [
        countToken: "COUNT",
        count: string
        | number,
        millisecondsToken: "BLOCK",
        milliseconds: string | number,
        streamsToken: "STREAMS",
        ...args: RedisValue[],
        callback: Callback<
            [key: Buffer, items: [id: Buffer, fields: Buffer[]][]][],
        >,
    ],
): Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
Parameters
- ...args: [
      countToken: "COUNT",
      count: string
      | number,
      millisecondsToken: "BLOCK",
      milliseconds: string | number,
      streamsToken: "STREAMS",
      ...args: RedisValue[],
      callback: Callback<
          [key: Buffer, items: [id: Buffer, fields: Buffer[]][]][],
      >,
  ]
Returns Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
Inherited from Commander.xreadBuffer
- Defined in utils/RedisCommander.ts:11030
xreadBuffer(
    ...args: [
        countToken: "COUNT",
        count: string
        | number,
        millisecondsToken: "BLOCK",
        milliseconds: string | number,
        streamsToken: "STREAMS",
        ...args: RedisValue[],
    ],
): Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
Parameters
- ...args: [
      countToken: "COUNT",
      count: string
      | number,
      millisecondsToken: "BLOCK",
      milliseconds: string | number,
      streamsToken: "STREAMS",
      ...args: RedisValue[],
  ]
Returns Promise<[key: Buffer, items: [id: Buffer, fields: Buffer[]][]][]>
Inherited from Commander.xreadBuffer
- Defined in utils/RedisCommander.ts:11059

xreadgroup

xreadgroup(
    ...args: [
        groupBlockToken: "GROUP",
        group: string
        | Buffer,
        consumer: string | Buffer,
        streamsToken: "STREAMS",
        ...args: RedisValue[],
        callback: Callback<unknown[]>,
    ],
): Promise<unknown[]>
Returns new or historical messages from a stream for a consumer in a group. Blocks until a message is available otherwise.
- group: stream
- complexity: For each stream mentioned: O(M) with M being the number of elements returned. If M is constant (e.g. always asking for the first 10 elements with COUNT), you can consider it O(1). On the other side when XREADGROUP blocks, XADD will pay the O(N) time in order to serve the N clients blocked on the stream getting new data.
- since: 5.0.0
Parameters
- ...args: [
      groupBlockToken: "GROUP",
      group: string
      | Buffer,
      consumer: string | Buffer,
      streamsToken: "STREAMS",
      ...args: RedisValue[],
      callback: Callback<unknown[]>,
  ]
Returns Promise<unknown[]>
Inherited from Commander.xreadgroup
- Defined in utils/RedisCommander.ts:11079
xreadgroup(
    ...args: [
        groupBlockToken: "GROUP",
        group: string
        | Buffer,
        consumer: string | Buffer,
        streamsToken: "STREAMS",
        ...args: RedisValue[],
    ],
): Promise<unknown[]>
Parameters
- ...args: [
      groupBlockToken: "GROUP",
      group: string
      | Buffer,
      consumer: string | Buffer,
      streamsToken: "STREAMS",
      ...args: RedisValue[],
  ]
Returns Promise<unknown[]>
Inherited from Commander.xreadgroup
- Defined in utils/RedisCommander.ts:11089
xreadgroup(
    ...args: [
        groupBlockToken: "GROUP",
        group: string
        | Buffer,
        consumer: string | Buffer,
        noack: "NOACK",
        streamsToken: "STREAMS",
        ...args: RedisValue[],
        callback: Callback<unknown[]>,
    ],
): Promise<unknown[]>
Parameters
- ...args: [
      groupBlockToken: "GROUP",
      group: string
      | Buffer,
      consumer: string | Buffer,
      noack: "NOACK",
      streamsToken: "STREAMS",
      ...args: RedisValue[],
      callback: Callback<unknown[]>,
  ]
Returns Promise<unknown[]>
Inherited from Commander.xreadgroup
- Defined in utils/RedisCommander.ts:11098
xreadgroup(
    ...args: [
        groupBlockToken: "GROUP",
        group: string
        | Buffer,
        consumer: string | Buffer,
        noack: "NOACK",
        streamsToken: "STREAMS",
        ...args: RedisValue[],
    ],
): Promise<unknown[]>
Parameters
- ...args: [
      groupBlockToken: "GROUP",
      group: string
      | Buffer,
      consumer: string | Buffer,
      noack: "NOACK",
      streamsToken: "STREAMS",
      ...args: RedisValue[],
  ]
Returns Promise<unknown[]>
Inherited from Commander.xreadgroup
- Defined in utils/RedisCommander.ts:11109
xreadgroup(
    ...args: [
        groupBlockToken: "GROUP",
        group: string
        | Buffer,
        consumer: string | Buffer,
        millisecondsToken: "BLOCK",
        milliseconds: string | number,
        streamsToken: "STREAMS",
        ...args: RedisValue[],
        callback: Callback<unknown[]>,
    ],
): Promise<unknown[]>
Parameters
- ...args: [
      groupBlockToken: "GROUP",
      group: string
      | Buffer,
      consumer: string | Buffer,
      millisecondsToken: "BLOCK",
      milliseconds: string | number,
      streamsToken: "STREAMS",
      ...args: RedisValue[],
      callback: Callback<unknown[]>,
  ]
Returns Promise<unknown[]>
Inherited from Commander.xreadgroup
- Defined in utils/RedisCommander.ts:11119
xreadgroup(
    ...args: [
        groupBlockToken: "GROUP",
        group: string
        | Buffer,
        consumer: string | Buffer,
        millisecondsToken: "BLOCK",
        milliseconds: string | number,
        streamsToken: "STREAMS",
        ...args: RedisValue[],
    ],
): Promise<unknown[]>
Parameters
- ...args: [
      groupBlockToken: "GROUP",
      group: string
      | Buffer,
      consumer: string | Buffer,
      millisecondsToken: "BLOCK",
      milliseconds: string | number,
      streamsToken: "STREAMS",
      ...args: RedisValue[],
  ]
Returns Promise<unknown[]>
Inherited from Commander.xreadgroup
- Defined in utils/RedisCommander.ts:11131
xreadgroup(
    ...args: [
        groupBlockToken: "GROUP",
        group: string
        | Buffer,
        consumer: string | Buffer,
        millisecondsToken: "BLOCK",
        milliseconds: string | number,
        noack: "NOACK",
        streamsToken: "STREAMS",
        ...args: RedisValue[],
        callback: Callback<unknown[]>,
    ],
): Promise<unknown[]>
Parameters
- ...args: [
      groupBlockToken: "GROUP",
      group: string
      | Buffer,
      consumer: string | Buffer,
      millisecondsToken: "BLOCK",
      milliseconds: string | number,
      noack: "NOACK",
      streamsToken: "STREAMS",
      ...args: RedisValue[],
      callback: Callback<unknown[]>,
  ]
Returns Promise<unknown[]>
Inherited from Commander.xreadgroup
- Defined in utils/RedisCommander.ts:11142
xreadgroup(
    ...args: [
        groupBlockToken: "GROUP",
        group: string
        | Buffer,
        consumer: string | Buffer,
        millisecondsToken: "BLOCK",
        milliseconds: string | number,
        noack: "NOACK",
        streamsToken: "STREAMS",
        ...args: RedisValue[],
    ],
): Promise<unknown[]>
Parameters
- ...args: [
      groupBlockToken: "GROUP",
      group: string
      | Buffer,
      consumer: string | Buffer,
      millisecondsToken: "BLOCK",
      milliseconds: string | number,
      noack: "NOACK",
      streamsToken: "STREAMS",
      ...args: RedisValue[],
  ]
Returns Promise<unknown[]>
Inherited from Commander.xreadgroup
- Defined in utils/RedisCommander.ts:11155
xreadgroup(
    ...args: [
        groupBlockToken: "GROUP",
        group: string
        | Buffer,
        consumer: string | Buffer,
        countToken: "COUNT",
        count: string | number,
        streamsToken: "STREAMS",
        ...args: RedisValue[],
        callback: Callback<unknown[]>,
    ],
): Promise<unknown[]>
Parameters
- ...args: [
      groupBlockToken: "GROUP",
      group: string
      | Buffer,
      consumer: string | Buffer,
      countToken: "COUNT",
      count: string | number,
      streamsToken: "STREAMS",
      ...args: RedisValue[],
      callback: Callback<unknown[]>,
  ]
Returns Promise<unknown[]>
Inherited from Commander.xreadgroup
- Defined in utils/RedisCommander.ts:11167
xreadgroup(
    ...args: [
        groupBlockToken: "GROUP",
        group: string
        | Buffer,
        consumer: string | Buffer,
        countToken: "COUNT",
        count: string | number,
        streamsToken: "STREAMS",
        ...args: RedisValue[],
    ],
): Promise<unknown[]>
Parameters
- ...args: [
      groupBlockToken: "GROUP",
      group: string
      | Buffer,
      consumer: string | Buffer,
      countToken: "COUNT",
      count: string | number,
      streamsToken: "STREAMS",
      ...args: RedisValue[],
  ]
Returns Promise<unknown[]>
Inherited from Commander.xreadgroup
- Defined in utils/RedisCommander.ts:11179
xreadgroup(
    ...args: [
        groupBlockToken: "GROUP",
        group: string
        | Buffer,
        consumer: string | Buffer,
        countToken: "COUNT",
        count: string | number,
        noack: "NOACK",
        streamsToken: "STREAMS",
        ...args: RedisValue[],
        callback: Callback<unknown[]>,
    ],
): Promise<unknown[]>
Parameters
- ...args: [
      groupBlockToken: "GROUP",
      group: string
      | Buffer,
      consumer: string | Buffer,
      countToken: "COUNT",
      count: string | number,
      noack: "NOACK",
      streamsToken: "STREAMS",
      ...args: RedisValue[],
      callback: Callback<unknown[]>,
  ]
Returns Promise<unknown[]>
Inherited from Commander.xreadgroup
- Defined in utils/RedisCommander.ts:11190
xreadgroup(
    ...args: [
        groupBlockToken: "GROUP",
        group: string
        | Buffer,
        consumer: string | Buffer,
        countToken: "COUNT",
        count: string | number,
        noack: "NOACK",
        streamsToken: "STREAMS",
        ...args: RedisValue[],
    ],
): Promise<unknown[]>
Parameters
- ...args: [
      groupBlockToken: "GROUP",
      group: string
      | Buffer,
      consumer: string | Buffer,
      countToken: "COUNT",
      count: string | number,
      noack: "NOACK",
      streamsToken: "STREAMS",
      ...args: RedisValue[],
  ]
Returns Promise<unknown[]>
Inherited from Commander.xreadgroup
- Defined in utils/RedisCommander.ts:11203
xreadgroup(
    ...args: [
        groupBlockToken: "GROUP",
        group: string
        | Buffer,
        consumer: string | Buffer,
        countToken: "COUNT",
        count: string | number,
        millisecondsToken: "BLOCK",
        milliseconds: string | number,
        streamsToken: "STREAMS",
        ...args: RedisValue[],
        callback: Callback<unknown[]>,
    ],
): Promise<unknown[]>
Parameters
- ...args: [
      groupBlockToken: "GROUP",
      group: string
      | Buffer,
      consumer: string | Buffer,
      countToken: "COUNT",
      count: string | number,
      millisecondsToken: "BLOCK",
      milliseconds: string | number,
      streamsToken: "STREAMS",
      ...args: RedisValue[],
      callback: Callback<unknown[]>,
  ]
Returns Promise<unknown[]>
Inherited from Commander.xreadgroup
- Defined in utils/RedisCommander.ts:11215
xreadgroup(
    ...args: [
        groupBlockToken: "GROUP",
        group: string
        | Buffer,
        consumer: string | Buffer,
        countToken: "COUNT",
        count: string | number,
        millisecondsToken: "BLOCK",
        milliseconds: string | number,
        streamsToken: "STREAMS",
        ...args: RedisValue[],
    ],
): Promise<unknown[]>
Parameters
- ...args: [
      groupBlockToken: "GROUP",
      group: string
      | Buffer,
      consumer: string | Buffer,
      countToken: "COUNT",
      count: string | number,
      millisecondsToken: "BLOCK",
      milliseconds: string | number,
      streamsToken: "STREAMS",
      ...args: RedisValue[],
  ]
Returns Promise<unknown[]>
Inherited from Commander.xreadgroup
- Defined in utils/RedisCommander.ts:11229
xreadgroup(
    ...args: [
        groupBlockToken: "GROUP",
        group: string
        | Buffer,
        consumer: string | Buffer,
        countToken: "COUNT",
        count: string | number,
        millisecondsToken: "BLOCK",
        milliseconds: string | number,
        noack: "NOACK",
        streamsToken: "STREAMS",
        ...args: RedisValue[],
        callback: Callback<unknown[]>,
    ],
): Promise<unknown[]>
Parameters
- ...args: [
      groupBlockToken: "GROUP",
      group: string
      | Buffer,
      consumer: string | Buffer,
      countToken: "COUNT",
      count: string | number,
      millisecondsToken: "BLOCK",
      milliseconds: string | number,
      noack: "NOACK",
      streamsToken: "STREAMS",
      ...args: RedisValue[],
      callback: Callback<unknown[]>,
  ]
Returns Promise<unknown[]>
Inherited from Commander.xreadgroup
- Defined in utils/RedisCommander.ts:11242
xreadgroup(
    ...args: [
        groupBlockToken: "GROUP",
        group: string
        | Buffer,
        consumer: string | Buffer,
        countToken: "COUNT",
        count: string | number,
        millisecondsToken: "BLOCK",
        milliseconds: string | number,
        noack: "NOACK",
        streamsToken: "STREAMS",
        ...args: RedisValue[],
    ],
): Promise<unknown[]>
Parameters
- ...args: [
      groupBlockToken: "GROUP",
      group: string
      | Buffer,
      consumer: string | Buffer,
      countToken: "COUNT",
      count: string | number,
      millisecondsToken: "BLOCK",
      milliseconds: string | number,
      noack: "NOACK",
      streamsToken: "STREAMS",
      ...args: RedisValue[],
  ]
Returns Promise<unknown[]>
Inherited from Commander.xreadgroup
- Defined in utils/RedisCommander.ts:11257

xrevrange

xrevrange(
    key: RedisKey,
    end: string | number | Buffer,
    start: string | number | Buffer,
    callback?: Callback<[id: string, fields: string[]][]>,
): Promise<[id: string, fields: string[]][]>
Returns the messages from a stream within a range of IDs in reverse order.
- group: stream
- complexity: O(N) with N being the number of elements returned. If N is constant (e.g. always asking for the first 10 elements with COUNT), you can consider it O(1).
- since: 5.0.0
Parameters
- key: RedisKey
- end: string | number | Buffer
- start: string | number | Buffer
- Optionalcallback: Callback<[id: string, fields: string[]][]>
Returns Promise<[id: string, fields: string[]][]>
Inherited from Commander.xrevrange
- Defined in utils/RedisCommander.ts:11278
xrevrange(
    key: RedisKey,
    end: string | number | Buffer,
    start: string | number | Buffer,
    countToken: "COUNT",
    count: string | number,
    callback?: Callback<[id: string, fields: string[]][]>,
): Promise<[id: string, fields: string[]][]>
Parameters
- key: RedisKey
- end: string | number | Buffer
- start: string | number | Buffer
- countToken: "COUNT"
- count: string | number
- Optionalcallback: Callback<[id: string, fields: string[]][]>
Returns Promise<[id: string, fields: string[]][]>
Inherited from Commander.xrevrange
- Defined in utils/RedisCommander.ts:11290

xrevrangeBuffer

xrevrangeBuffer(
    key: RedisKey,
    end: string | number | Buffer,
    start: string | number | Buffer,
    callback?: Callback<[id: Buffer, fields: Buffer[]][]>,
): Promise<[id: Buffer, fields: Buffer[]][]>
Parameters
- key: RedisKey
- end: string | number | Buffer
- start: string | number | Buffer
- Optionalcallback: Callback<[id: Buffer, fields: Buffer[]][]>
Returns Promise<[id: Buffer, fields: Buffer[]][]>
Inherited from Commander.xrevrangeBuffer
- Defined in utils/RedisCommander.ts:11284
xrevrangeBuffer(
    key: RedisKey,
    end: string | number | Buffer,
    start: string | number | Buffer,
    countToken: "COUNT",
    count: string | number,
    callback?: Callback<[id: Buffer, fields: Buffer[]][]>,
): Promise<[id: Buffer, fields: Buffer[]][]>
Parameters
- key: RedisKey
- end: string | number | Buffer
- start: string | number | Buffer
- countToken: "COUNT"
- count: string | number
- Optionalcallback: Callback<[id: Buffer, fields: Buffer[]][]>
Returns Promise<[id: Buffer, fields: Buffer[]][]>
Inherited from Commander.xrevrangeBuffer
- Defined in utils/RedisCommander.ts:11298

xsetid

xsetid(
    key: RedisKey,
    lastId: string | number | Buffer,
    callback?: Callback<unknown>,
): Promise<unknown>
An internal command for replicating stream values.
- group: stream
- complexity: O(1)
- since: 5.0.0
Parameters
- key: RedisKey
- lastId: string | number | Buffer
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.xsetid
- Defined in utils/RedisCommander.ts:11313
xsetid(
    key: RedisKey,
    lastId: string | number | Buffer,
    maxDeletedIdToken: "MAXDELETEDID",
    maxDeletedId: string | number | Buffer,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- lastId: string | number | Buffer
- maxDeletedIdToken: "MAXDELETEDID"
- maxDeletedId: string | number | Buffer
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.xsetid
- Defined in utils/RedisCommander.ts:11318
xsetid(
    key: RedisKey,
    lastId: string | number | Buffer,
    entriesAddedToken: "ENTRIESADDED",
    entriesAdded: string | number,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- lastId: string | number | Buffer
- entriesAddedToken: "ENTRIESADDED"
- entriesAdded: string | number
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.xsetid
- Defined in utils/RedisCommander.ts:11325
xsetid(
    key: RedisKey,
    lastId: string | number | Buffer,
    entriesAddedToken: "ENTRIESADDED",
    entriesAdded: string | number,
    maxDeletedIdToken: "MAXDELETEDID",
    maxDeletedId: string | number | Buffer,
    callback?: Callback<unknown>,
): Promise<unknown>
Parameters
- key: RedisKey
- lastId: string | number | Buffer
- entriesAddedToken: "ENTRIESADDED"
- entriesAdded: string | number
- maxDeletedIdToken: "MAXDELETEDID"
- maxDeletedId: string | number | Buffer
- Optionalcallback: Callback<unknown>
Returns Promise<unknown>
Inherited from Commander.xsetid
- Defined in utils/RedisCommander.ts:11332

xtrim

xtrim(
    key: RedisKey,
    maxlen: "MAXLEN",
    threshold: string | number | Buffer,
    callback?: Callback<number>,
): Promise<number>
Deletes messages from the beginning of a stream.
- group: stream
- complexity: O(N), with N being the number of evicted entries. Constant times are very small however, since entries are organized in macro nodes containing multiple entries that can be released with a single deallocation.
- since: 5.0.0
Parameters
- key: RedisKey
- maxlen: "MAXLEN"
- threshold: string | number | Buffer
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.xtrim
- Defined in utils/RedisCommander.ts:11348
xtrim(
    key: RedisKey,
    maxlen: "MAXLEN",
    threshold: string | number | Buffer,
    countToken: "LIMIT",
    count: string | number,
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- maxlen: "MAXLEN"
- threshold: string | number | Buffer
- countToken: "LIMIT"
- count: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.xtrim
- Defined in utils/RedisCommander.ts:11354
xtrim(
    key: RedisKey,
    maxlen: "MAXLEN",
    equal: "=",
    threshold: string | number | Buffer,
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- maxlen: "MAXLEN"
- equal: "="
- threshold: string | number | Buffer
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.xtrim
- Defined in utils/RedisCommander.ts:11362
xtrim(
    key: RedisKey,
    maxlen: "MAXLEN",
    equal: "=",
    threshold: string | number | Buffer,
    countToken: "LIMIT",
    count: string | number,
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- maxlen: "MAXLEN"
- equal: "="
- threshold: string | number | Buffer
- countToken: "LIMIT"
- count: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.xtrim
- Defined in utils/RedisCommander.ts:11369
xtrim(
    key: RedisKey,
    maxlen: "MAXLEN",
    approximately: "~",
    threshold: string | number | Buffer,
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- maxlen: "MAXLEN"
- approximately: "~"
- threshold: string | number | Buffer
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.xtrim
- Defined in utils/RedisCommander.ts:11378
xtrim(
    key: RedisKey,
    maxlen: "MAXLEN",
    approximately: "~",
    threshold: string | number | Buffer,
    countToken: "LIMIT",
    count: string | number,
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- maxlen: "MAXLEN"
- approximately: "~"
- threshold: string | number | Buffer
- countToken: "LIMIT"
- count: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.xtrim
- Defined in utils/RedisCommander.ts:11385
xtrim(
    key: RedisKey,
    minid: "MINID",
    threshold: string | number | Buffer,
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- minid: "MINID"
- threshold: string | number | Buffer
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.xtrim
- Defined in utils/RedisCommander.ts:11394
xtrim(
    key: RedisKey,
    minid: "MINID",
    threshold: string | number | Buffer,
    countToken: "LIMIT",
    count: string | number,
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- minid: "MINID"
- threshold: string | number | Buffer
- countToken: "LIMIT"
- count: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.xtrim
- Defined in utils/RedisCommander.ts:11400
xtrim(
    key: RedisKey,
    minid: "MINID",
    equal: "=",
    threshold: string | number | Buffer,
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- minid: "MINID"
- equal: "="
- threshold: string | number | Buffer
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.xtrim
- Defined in utils/RedisCommander.ts:11408
xtrim(
    key: RedisKey,
    minid: "MINID",
    equal: "=",
    threshold: string | number | Buffer,
    countToken: "LIMIT",
    count: string | number,
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- minid: "MINID"
- equal: "="
- threshold: string | number | Buffer
- countToken: "LIMIT"
- count: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.xtrim
- Defined in utils/RedisCommander.ts:11415
xtrim(
    key: RedisKey,
    minid: "MINID",
    approximately: "~",
    threshold: string | number | Buffer,
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- minid: "MINID"
- approximately: "~"
- threshold: string | number | Buffer
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.xtrim
- Defined in utils/RedisCommander.ts:11424
xtrim(
    key: RedisKey,
    minid: "MINID",
    approximately: "~",
    threshold: string | number | Buffer,
    countToken: "LIMIT",
    count: string | number,
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- minid: "MINID"
- approximately: "~"
- threshold: string | number | Buffer
- countToken: "LIMIT"
- count: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.xtrim
- Defined in utils/RedisCommander.ts:11431

zadd

zadd(
    ...args: [
        key: RedisKey,
        ...data: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Adds one or more members to a sorted set, or updates their scores. Creates the key if it doesn't exist.
- group: sorted-set
- complexity: O(log(N)) for each item added, where N is the number of elements in the sorted set.
- since: 1.2.0
Parameters
- ...args: [
      key: RedisKey,
      ...data: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11447
zadd(
...args: [key: RedisKey, ...data: (string | number | Buffer)[]],
): Promise<number>
Parameters
- ...args: [key: RedisKey, ...data: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11454
zadd(
    ...args: [
        key: RedisKey,
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<string>,
    ],
): Promise<string>
Parameters
- ...args: [
      key: RedisKey,
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<string>,
  ]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11457
zadd(
    ...args: [
        key: RedisKey,
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<string>
Parameters
- ...args: [key: RedisKey, incr: "INCR", ...data: (string | number | Buffer)[]]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11473
zadd(
    ...args: [
        key: RedisKey,
        ch: "CH",
        ...data: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      key: RedisKey,
      ch: "CH",
      ...data: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11487
zadd(
    ...args: [
        key: RedisKey,
        ch: "CH",
        ...data: (string | number | Buffer)[],
    ],
): Promise<number>
Parameters
- ...args: [key: RedisKey, ch: "CH", ...data: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11495
zadd(
    ...args: [
        key: RedisKey,
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<string>,
    ],
): Promise<string>
Parameters
- ...args: [
      key: RedisKey,
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<string>,
  ]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11498
zadd(
    ...args: [
        key: RedisKey,
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<string>
Parameters
- ...args: [key: RedisKey, ch: "CH", incr: "INCR", ...data: (string | number | Buffer)[]]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11516
zadd(
    ...args: [
        key: RedisKey,
        gt: "GT",
        ...data: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      key: RedisKey,
      gt: "GT",
      ...data: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11532
zadd(
    ...args: [
        key: RedisKey,
        gt: "GT",
        ...data: (string | number | Buffer)[],
    ],
): Promise<number>
Parameters
- ...args: [key: RedisKey, gt: "GT", ...data: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11540
zadd(
    ...args: [
        key: RedisKey,
        gt: "GT",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<string>,
    ],
): Promise<string>
Parameters
- ...args: [
      key: RedisKey,
      gt: "GT",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<string>,
  ]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11543
zadd(
    ...args: [
        key: RedisKey,
        gt: "GT",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<string>
Parameters
- ...args: [key: RedisKey, gt: "GT", incr: "INCR", ...data: (string | number | Buffer)[]]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11561
zadd(
    ...args: [
        key: RedisKey,
        gt: "GT",
        ch: "CH",
        ...data: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      key: RedisKey,
      gt: "GT",
      ch: "CH",
      ...data: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11577
zadd(
    ...args: [
        key: RedisKey,
        gt: "GT",
        ch: "CH",
        ...data: (string | number | Buffer)[],
    ],
): Promise<number>
Parameters
- ...args: [key: RedisKey, gt: "GT", ch: "CH", ...data: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11586
zadd(
    ...args: [
        key: RedisKey,
        gt: "GT",
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<string>,
    ],
): Promise<string>
Parameters
- ...args: [
      key: RedisKey,
      gt: "GT",
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<string>,
  ]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11594
zadd(
    ...args: [
        key: RedisKey,
        gt: "GT",
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<string>
Parameters
- ...args: [
      key: RedisKey,
      gt: "GT",
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
  ]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11614
zadd(
    ...args: [
        key: RedisKey,
        lt: "LT",
        ...data: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      key: RedisKey,
      lt: "LT",
      ...data: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11632
zadd(
    ...args: [
        key: RedisKey,
        lt: "LT",
        ...data: (string | number | Buffer)[],
    ],
): Promise<number>
Parameters
- ...args: [key: RedisKey, lt: "LT", ...data: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11640
zadd(
    ...args: [
        key: RedisKey,
        lt: "LT",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<string>,
    ],
): Promise<string>
Parameters
- ...args: [
      key: RedisKey,
      lt: "LT",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<string>,
  ]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11643
zadd(
    ...args: [
        key: RedisKey,
        lt: "LT",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<string>
Parameters
- ...args: [key: RedisKey, lt: "LT", incr: "INCR", ...data: (string | number | Buffer)[]]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11661
zadd(
    ...args: [
        key: RedisKey,
        lt: "LT",
        ch: "CH",
        ...data: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      key: RedisKey,
      lt: "LT",
      ch: "CH",
      ...data: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11677
zadd(
    ...args: [
        key: RedisKey,
        lt: "LT",
        ch: "CH",
        ...data: (string | number | Buffer)[],
    ],
): Promise<number>
Parameters
- ...args: [key: RedisKey, lt: "LT", ch: "CH", ...data: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11686
zadd(
    ...args: [
        key: RedisKey,
        lt: "LT",
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<string>,
    ],
): Promise<string>
Parameters
- ...args: [
      key: RedisKey,
      lt: "LT",
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<string>,
  ]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11694
zadd(
    ...args: [
        key: RedisKey,
        lt: "LT",
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<string>
Parameters
- ...args: [
      key: RedisKey,
      lt: "LT",
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
  ]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11714
zadd(
    ...args: [
        key: RedisKey,
        nx: "NX",
        ...data: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      key: RedisKey,
      nx: "NX",
      ...data: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11732
zadd(
    ...args: [
        key: RedisKey,
        nx: "NX",
        ...data: (string | number | Buffer)[],
    ],
): Promise<number>
Parameters
- ...args: [key: RedisKey, nx: "NX", ...data: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11740
zadd(
    ...args: [
        key: RedisKey,
        nx: "NX",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<string>,
    ],
): Promise<string>
Parameters
- ...args: [
      key: RedisKey,
      nx: "NX",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<string>,
  ]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11743
zadd(
    ...args: [
        key: RedisKey,
        nx: "NX",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<string>
Parameters
- ...args: [key: RedisKey, nx: "NX", incr: "INCR", ...data: (string | number | Buffer)[]]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11761
zadd(
    ...args: [
        key: RedisKey,
        nx: "NX",
        ch: "CH",
        ...data: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      key: RedisKey,
      nx: "NX",
      ch: "CH",
      ...data: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11777
zadd(
    ...args: [
        key: RedisKey,
        nx: "NX",
        ch: "CH",
        ...data: (string | number | Buffer)[],
    ],
): Promise<number>
Parameters
- ...args: [key: RedisKey, nx: "NX", ch: "CH", ...data: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11786
zadd(
    ...args: [
        key: RedisKey,
        nx: "NX",
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<string>,
    ],
): Promise<string>
Parameters
- ...args: [
      key: RedisKey,
      nx: "NX",
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<string>,
  ]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11794
zadd(
    ...args: [
        key: RedisKey,
        nx: "NX",
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<string>
Parameters
- ...args: [
      key: RedisKey,
      nx: "NX",
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
  ]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11814
zadd(
    ...args: [
        key: RedisKey,
        nx: "NX",
        gt: "GT",
        ...data: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      key: RedisKey,
      nx: "NX",
      gt: "GT",
      ...data: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11832
zadd(
    ...args: [
        key: RedisKey,
        nx: "NX",
        gt: "GT",
        ...data: (string | number | Buffer)[],
    ],
): Promise<number>
Parameters
- ...args: [key: RedisKey, nx: "NX", gt: "GT", ...data: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11841
zadd(
    ...args: [
        key: RedisKey,
        nx: "NX",
        gt: "GT",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<string>,
    ],
): Promise<string>
Parameters
- ...args: [
      key: RedisKey,
      nx: "NX",
      gt: "GT",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<string>,
  ]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11849
zadd(
    ...args: [
        key: RedisKey,
        nx: "NX",
        gt: "GT",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<string>
Parameters
- ...args: [
      key: RedisKey,
      nx: "NX",
      gt: "GT",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
  ]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11869
zadd(
    ...args: [
        key: RedisKey,
        nx: "NX",
        gt: "GT",
        ch: "CH",
        ...data: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      key: RedisKey,
      nx: "NX",
      gt: "GT",
      ch: "CH",
      ...data: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11887
zadd(
    ...args: [
        key: RedisKey,
        nx: "NX",
        gt: "GT",
        ch: "CH",
        ...data: (string | number | Buffer)[],
    ],
): Promise<number>
Parameters
- ...args: [
      key: RedisKey,
      nx: "NX",
      gt: "GT",
      ch: "CH",
      ...data: (string | number | Buffer)[],
  ]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11897
zadd(
    ...args: [
        key: RedisKey,
        nx: "NX",
        gt: "GT",
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<string>,
    ],
): Promise<string>
Parameters
- ...args: [
      key: RedisKey,
      nx: "NX",
      gt: "GT",
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<string>,
  ]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11906
zadd(
    ...args: [
        key: RedisKey,
        nx: "NX",
        gt: "GT",
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<string>
Parameters
- ...args: [
      key: RedisKey,
      nx: "NX",
      gt: "GT",
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
  ]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11928
zadd(
    ...args: [
        key: RedisKey,
        nx: "NX",
        lt: "LT",
        ...data: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      key: RedisKey,
      nx: "NX",
      lt: "LT",
      ...data: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11948
zadd(
    ...args: [
        key: RedisKey,
        nx: "NX",
        lt: "LT",
        ...data: (string | number | Buffer)[],
    ],
): Promise<number>
Parameters
- ...args: [key: RedisKey, nx: "NX", lt: "LT", ...data: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11957
zadd(
    ...args: [
        key: RedisKey,
        nx: "NX",
        lt: "LT",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<string>,
    ],
): Promise<string>
Parameters
- ...args: [
      key: RedisKey,
      nx: "NX",
      lt: "LT",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<string>,
  ]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11965
zadd(
    ...args: [
        key: RedisKey,
        nx: "NX",
        lt: "LT",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<string>
Parameters
- ...args: [
      key: RedisKey,
      nx: "NX",
      lt: "LT",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
  ]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:11985
zadd(
    ...args: [
        key: RedisKey,
        nx: "NX",
        lt: "LT",
        ch: "CH",
        ...data: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      key: RedisKey,
      nx: "NX",
      lt: "LT",
      ch: "CH",
      ...data: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:12003
zadd(
    ...args: [
        key: RedisKey,
        nx: "NX",
        lt: "LT",
        ch: "CH",
        ...data: (string | number | Buffer)[],
    ],
): Promise<number>
Parameters
- ...args: [
      key: RedisKey,
      nx: "NX",
      lt: "LT",
      ch: "CH",
      ...data: (string | number | Buffer)[],
  ]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:12013
zadd(
    ...args: [
        key: RedisKey,
        nx: "NX",
        lt: "LT",
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<string>,
    ],
): Promise<string>
Parameters
- ...args: [
      key: RedisKey,
      nx: "NX",
      lt: "LT",
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<string>,
  ]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:12022
zadd(
    ...args: [
        key: RedisKey,
        nx: "NX",
        lt: "LT",
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<string>
Parameters
- ...args: [
      key: RedisKey,
      nx: "NX",
      lt: "LT",
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
  ]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:12044
zadd(
    ...args: [
        key: RedisKey,
        xx: "XX",
        ...data: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      key: RedisKey,
      xx: "XX",
      ...data: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:12064
zadd(
    ...args: [
        key: RedisKey,
        xx: "XX",
        ...data: (string | number | Buffer)[],
    ],
): Promise<number>
Parameters
- ...args: [key: RedisKey, xx: "XX", ...data: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:12072
zadd(
    ...args: [
        key: RedisKey,
        xx: "XX",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<string>,
    ],
): Promise<string>
Parameters
- ...args: [
      key: RedisKey,
      xx: "XX",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<string>,
  ]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:12075
zadd(
    ...args: [
        key: RedisKey,
        xx: "XX",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<string>
Parameters
- ...args: [key: RedisKey, xx: "XX", incr: "INCR", ...data: (string | number | Buffer)[]]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:12093
zadd(
    ...args: [
        key: RedisKey,
        xx: "XX",
        ch: "CH",
        ...data: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      key: RedisKey,
      xx: "XX",
      ch: "CH",
      ...data: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:12109
zadd(
    ...args: [
        key: RedisKey,
        xx: "XX",
        ch: "CH",
        ...data: (string | number | Buffer)[],
    ],
): Promise<number>
Parameters
- ...args: [key: RedisKey, xx: "XX", ch: "CH", ...data: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:12118
zadd(
    ...args: [
        key: RedisKey,
        xx: "XX",
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<string>,
    ],
): Promise<string>
Parameters
- ...args: [
      key: RedisKey,
      xx: "XX",
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<string>,
  ]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:12126
zadd(
    ...args: [
        key: RedisKey,
        xx: "XX",
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<string>
Parameters
- ...args: [
      key: RedisKey,
      xx: "XX",
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
  ]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:12146
zadd(
    ...args: [
        key: RedisKey,
        xx: "XX",
        gt: "GT",
        ...data: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      key: RedisKey,
      xx: "XX",
      gt: "GT",
      ...data: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:12164
zadd(
    ...args: [
        key: RedisKey,
        xx: "XX",
        gt: "GT",
        ...data: (string | number | Buffer)[],
    ],
): Promise<number>
Parameters
- ...args: [key: RedisKey, xx: "XX", gt: "GT", ...data: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:12173
zadd(
    ...args: [
        key: RedisKey,
        xx: "XX",
        gt: "GT",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<string>,
    ],
): Promise<string>
Parameters
- ...args: [
      key: RedisKey,
      xx: "XX",
      gt: "GT",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<string>,
  ]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:12181
zadd(
    ...args: [
        key: RedisKey,
        xx: "XX",
        gt: "GT",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<string>
Parameters
- ...args: [
      key: RedisKey,
      xx: "XX",
      gt: "GT",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
  ]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:12201
zadd(
    ...args: [
        key: RedisKey,
        xx: "XX",
        gt: "GT",
        ch: "CH",
        ...data: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      key: RedisKey,
      xx: "XX",
      gt: "GT",
      ch: "CH",
      ...data: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:12219
zadd(
    ...args: [
        key: RedisKey,
        xx: "XX",
        gt: "GT",
        ch: "CH",
        ...data: (string | number | Buffer)[],
    ],
): Promise<number>
Parameters
- ...args: [
      key: RedisKey,
      xx: "XX",
      gt: "GT",
      ch: "CH",
      ...data: (string | number | Buffer)[],
  ]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:12229
zadd(
    ...args: [
        key: RedisKey,
        xx: "XX",
        gt: "GT",
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<string>,
    ],
): Promise<string>
Parameters
- ...args: [
      key: RedisKey,
      xx: "XX",
      gt: "GT",
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<string>,
  ]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:12238
zadd(
    ...args: [
        key: RedisKey,
        xx: "XX",
        gt: "GT",
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<string>
Parameters
- ...args: [
      key: RedisKey,
      xx: "XX",
      gt: "GT",
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
  ]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:12260
zadd(
    ...args: [
        key: RedisKey,
        xx: "XX",
        lt: "LT",
        ...data: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      key: RedisKey,
      xx: "XX",
      lt: "LT",
      ...data: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:12280
zadd(
    ...args: [
        key: RedisKey,
        xx: "XX",
        lt: "LT",
        ...data: (string | number | Buffer)[],
    ],
): Promise<number>
Parameters
- ...args: [key: RedisKey, xx: "XX", lt: "LT", ...data: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:12289
zadd(
    ...args: [
        key: RedisKey,
        xx: "XX",
        lt: "LT",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<string>,
    ],
): Promise<string>
Parameters
- ...args: [
      key: RedisKey,
      xx: "XX",
      lt: "LT",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<string>,
  ]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:12297
zadd(
    ...args: [
        key: RedisKey,
        xx: "XX",
        lt: "LT",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<string>
Parameters
- ...args: [
      key: RedisKey,
      xx: "XX",
      lt: "LT",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
  ]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:12317
zadd(
    ...args: [
        key: RedisKey,
        xx: "XX",
        lt: "LT",
        ch: "CH",
        ...data: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      key: RedisKey,
      xx: "XX",
      lt: "LT",
      ch: "CH",
      ...data: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:12335
zadd(
    ...args: [
        key: RedisKey,
        xx: "XX",
        lt: "LT",
        ch: "CH",
        ...data: (string | number | Buffer)[],
    ],
): Promise<number>
Parameters
- ...args: [
      key: RedisKey,
      xx: "XX",
      lt: "LT",
      ch: "CH",
      ...data: (string | number | Buffer)[],
  ]
Returns Promise<number>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:12345
zadd(
    ...args: [
        key: RedisKey,
        xx: "XX",
        lt: "LT",
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<string>,
    ],
): Promise<string>
Parameters
- ...args: [
      key: RedisKey,
      xx: "XX",
      lt: "LT",
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<string>,
  ]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:12354
zadd(
    ...args: [
        key: RedisKey,
        xx: "XX",
        lt: "LT",
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<string>
Parameters
- ...args: [
      key: RedisKey,
      xx: "XX",
      lt: "LT",
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
  ]
Returns Promise<string>
Inherited from Commander.zadd
- Defined in utils/RedisCommander.ts:12376

zaddBuffer

zaddBuffer(
    ...args: [
        key: RedisKey,
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<Buffer>,
    ],
): Promise<Buffer>
Parameters
- ...args: [
      key: RedisKey,
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<Buffer>,
  ]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:11465
zaddBuffer(
    ...args: [
        key: RedisKey,
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<Buffer>
Parameters
- ...args: [key: RedisKey, incr: "INCR", ...data: (string | number | Buffer)[]]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:11480
zaddBuffer(
    ...args: [
        key: RedisKey,
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<Buffer>,
    ],
): Promise<Buffer>
Parameters
- ...args: [
      key: RedisKey,
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<Buffer>,
  ]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:11507
zaddBuffer(
    ...args: [
        key: RedisKey,
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<Buffer>
Parameters
- ...args: [key: RedisKey, ch: "CH", incr: "INCR", ...data: (string | number | Buffer)[]]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:11524
zaddBuffer(
    ...args: [
        key: RedisKey,
        gt: "GT",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<Buffer>,
    ],
): Promise<Buffer>
Parameters
- ...args: [
      key: RedisKey,
      gt: "GT",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<Buffer>,
  ]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:11552
zaddBuffer(
    ...args: [
        key: RedisKey,
        gt: "GT",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<Buffer>
Parameters
- ...args: [key: RedisKey, gt: "GT", incr: "INCR", ...data: (string | number | Buffer)[]]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:11569
zaddBuffer(
    ...args: [
        key: RedisKey,
        gt: "GT",
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<Buffer>,
    ],
): Promise<Buffer>
Parameters
- ...args: [
      key: RedisKey,
      gt: "GT",
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<Buffer>,
  ]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:11604
zaddBuffer(
    ...args: [
        key: RedisKey,
        gt: "GT",
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<Buffer>
Parameters
- ...args: [
      key: RedisKey,
      gt: "GT",
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
  ]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:11623
zaddBuffer(
    ...args: [
        key: RedisKey,
        lt: "LT",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<Buffer>,
    ],
): Promise<Buffer>
Parameters
- ...args: [
      key: RedisKey,
      lt: "LT",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<Buffer>,
  ]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:11652
zaddBuffer(
    ...args: [
        key: RedisKey,
        lt: "LT",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<Buffer>
Parameters
- ...args: [key: RedisKey, lt: "LT", incr: "INCR", ...data: (string | number | Buffer)[]]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:11669
zaddBuffer(
    ...args: [
        key: RedisKey,
        lt: "LT",
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<Buffer>,
    ],
): Promise<Buffer>
Parameters
- ...args: [
      key: RedisKey,
      lt: "LT",
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<Buffer>,
  ]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:11704
zaddBuffer(
    ...args: [
        key: RedisKey,
        lt: "LT",
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<Buffer>
Parameters
- ...args: [
      key: RedisKey,
      lt: "LT",
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
  ]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:11723
zaddBuffer(
    ...args: [
        key: RedisKey,
        nx: "NX",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<Buffer>,
    ],
): Promise<Buffer>
Parameters
- ...args: [
      key: RedisKey,
      nx: "NX",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<Buffer>,
  ]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:11752
zaddBuffer(
    ...args: [
        key: RedisKey,
        nx: "NX",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<Buffer>
Parameters
- ...args: [key: RedisKey, nx: "NX", incr: "INCR", ...data: (string | number | Buffer)[]]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:11769
zaddBuffer(
    ...args: [
        key: RedisKey,
        nx: "NX",
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<Buffer>,
    ],
): Promise<Buffer>
Parameters
- ...args: [
      key: RedisKey,
      nx: "NX",
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<Buffer>,
  ]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:11804
zaddBuffer(
    ...args: [
        key: RedisKey,
        nx: "NX",
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<Buffer>
Parameters
- ...args: [
      key: RedisKey,
      nx: "NX",
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
  ]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:11823
zaddBuffer(
    ...args: [
        key: RedisKey,
        nx: "NX",
        gt: "GT",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<Buffer>,
    ],
): Promise<Buffer>
Parameters
- ...args: [
      key: RedisKey,
      nx: "NX",
      gt: "GT",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<Buffer>,
  ]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:11859
zaddBuffer(
    ...args: [
        key: RedisKey,
        nx: "NX",
        gt: "GT",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<Buffer>
Parameters
- ...args: [
      key: RedisKey,
      nx: "NX",
      gt: "GT",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
  ]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:11878
zaddBuffer(
    ...args: [
        key: RedisKey,
        nx: "NX",
        gt: "GT",
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<Buffer>,
    ],
): Promise<Buffer>
Parameters
- ...args: [
      key: RedisKey,
      nx: "NX",
      gt: "GT",
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<Buffer>,
  ]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:11917
zaddBuffer(
    ...args: [
        key: RedisKey,
        nx: "NX",
        gt: "GT",
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<Buffer>
Parameters
- ...args: [
      key: RedisKey,
      nx: "NX",
      gt: "GT",
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
  ]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:11938
zaddBuffer(
    ...args: [
        key: RedisKey,
        nx: "NX",
        lt: "LT",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<Buffer>,
    ],
): Promise<Buffer>
Parameters
- ...args: [
      key: RedisKey,
      nx: "NX",
      lt: "LT",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<Buffer>,
  ]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:11975
zaddBuffer(
    ...args: [
        key: RedisKey,
        nx: "NX",
        lt: "LT",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<Buffer>
Parameters
- ...args: [
      key: RedisKey,
      nx: "NX",
      lt: "LT",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
  ]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:11994
zaddBuffer(
    ...args: [
        key: RedisKey,
        nx: "NX",
        lt: "LT",
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<Buffer>,
    ],
): Promise<Buffer>
Parameters
- ...args: [
      key: RedisKey,
      nx: "NX",
      lt: "LT",
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<Buffer>,
  ]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:12033
zaddBuffer(
    ...args: [
        key: RedisKey,
        nx: "NX",
        lt: "LT",
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<Buffer>
Parameters
- ...args: [
      key: RedisKey,
      nx: "NX",
      lt: "LT",
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
  ]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:12054
zaddBuffer(
    ...args: [
        key: RedisKey,
        xx: "XX",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<Buffer>,
    ],
): Promise<Buffer>
Parameters
- ...args: [
      key: RedisKey,
      xx: "XX",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<Buffer>,
  ]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:12084
zaddBuffer(
    ...args: [
        key: RedisKey,
        xx: "XX",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<Buffer>
Parameters
- ...args: [key: RedisKey, xx: "XX", incr: "INCR", ...data: (string | number | Buffer)[]]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:12101
zaddBuffer(
    ...args: [
        key: RedisKey,
        xx: "XX",
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<Buffer>,
    ],
): Promise<Buffer>
Parameters
- ...args: [
      key: RedisKey,
      xx: "XX",
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<Buffer>,
  ]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:12136
zaddBuffer(
    ...args: [
        key: RedisKey,
        xx: "XX",
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<Buffer>
Parameters
- ...args: [
      key: RedisKey,
      xx: "XX",
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
  ]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:12155
zaddBuffer(
    ...args: [
        key: RedisKey,
        xx: "XX",
        gt: "GT",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<Buffer>,
    ],
): Promise<Buffer>
Parameters
- ...args: [
      key: RedisKey,
      xx: "XX",
      gt: "GT",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<Buffer>,
  ]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:12191
zaddBuffer(
    ...args: [
        key: RedisKey,
        xx: "XX",
        gt: "GT",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<Buffer>
Parameters
- ...args: [
      key: RedisKey,
      xx: "XX",
      gt: "GT",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
  ]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:12210
zaddBuffer(
    ...args: [
        key: RedisKey,
        xx: "XX",
        gt: "GT",
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<Buffer>,
    ],
): Promise<Buffer>
Parameters
- ...args: [
      key: RedisKey,
      xx: "XX",
      gt: "GT",
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<Buffer>,
  ]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:12249
zaddBuffer(
    ...args: [
        key: RedisKey,
        xx: "XX",
        gt: "GT",
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<Buffer>
Parameters
- ...args: [
      key: RedisKey,
      xx: "XX",
      gt: "GT",
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
  ]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:12270
zaddBuffer(
    ...args: [
        key: RedisKey,
        xx: "XX",
        lt: "LT",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<Buffer>,
    ],
): Promise<Buffer>
Parameters
- ...args: [
      key: RedisKey,
      xx: "XX",
      lt: "LT",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<Buffer>,
  ]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:12307
zaddBuffer(
    ...args: [
        key: RedisKey,
        xx: "XX",
        lt: "LT",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<Buffer>
Parameters
- ...args: [
      key: RedisKey,
      xx: "XX",
      lt: "LT",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
  ]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:12326
zaddBuffer(
    ...args: [
        key: RedisKey,
        xx: "XX",
        lt: "LT",
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
        callback: Callback<Buffer>,
    ],
): Promise<Buffer>
Parameters
- ...args: [
      key: RedisKey,
      xx: "XX",
      lt: "LT",
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
      callback: Callback<Buffer>,
  ]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:12365
zaddBuffer(
    ...args: [
        key: RedisKey,
        xx: "XX",
        lt: "LT",
        ch: "CH",
        incr: "INCR",
        ...data: (string | number | Buffer)[],
    ],
): Promise<Buffer>
Parameters
- ...args: [
      key: RedisKey,
      xx: "XX",
      lt: "LT",
      ch: "CH",
      incr: "INCR",
      ...data: (string | number | Buffer)[],
  ]
Returns Promise<Buffer>
Inherited from Commander.zaddBuffer
- Defined in utils/RedisCommander.ts:12386

zcard

zcard(key: RedisKey, callback?: Callback<number>): Promise<number>
Returns the number of members in a sorted set.
- group: sorted-set
- complexity: O(1)
- since: 1.2.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.zcard
- Defined in utils/RedisCommander.ts:12403

zcount

zcount(
    key: RedisKey,
    min: string | number,
    max: string | number,
    callback?: Callback<number>,
): Promise<number>
Returns the count of members in a sorted set that have scores within a range.
- group: sorted-set
- complexity: O(log(N)) with N being the number of elements in the sorted set.
- since: 2.0.0
Parameters
- key: RedisKey
- min: string | number
- max: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.zcount
- Defined in utils/RedisCommander.ts:12411

zdiff

zdiff(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Returns the difference between multiple sorted sets.
- group: sorted-set
- complexity: O(L + (N-K)log(N)) worst case where L is the total number of elements in all the sets, N is the size of the first set, and K is the size of the result set.
- since: 6.2.0
Parameters
- ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Inherited from Commander.zdiff
- Defined in utils/RedisCommander.ts:12424
zdiff(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Inherited from Commander.zdiff
- Defined in utils/RedisCommander.ts:12438
zdiff(
...args: [numkeys: string | number, ...keys: RedisKey[]],
): Promise<string[]>
Parameters
- ...args: [numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<string[]>
Inherited from Commander.zdiff
- Defined in utils/RedisCommander.ts:12452
zdiff(...args: [numkeys: string | number, keys: RedisKey[]]): Promise<string[]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[]]
Returns Promise<string[]>
Inherited from Commander.zdiff
- Defined in utils/RedisCommander.ts:12458
zdiff(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        withscores: "WITHSCORES",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      withscores: "WITHSCORES",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zdiff
- Defined in utils/RedisCommander.ts:12464
zdiff(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        withscores: "WITHSCORES",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      withscores: "WITHSCORES",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zdiff
- Defined in utils/RedisCommander.ts:12480
zdiff(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        withscores: "WITHSCORES",
    ],
): Promise<string[]>
Parameters
- ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<string[]>
Inherited from Commander.zdiff
- Defined in utils/RedisCommander.ts:12496
zdiff(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        withscores: "WITHSCORES",
    ],
): Promise<string[]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<string[]>
Inherited from Commander.zdiff
- Defined in utils/RedisCommander.ts:12510

zdiffBuffer

zdiffBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Inherited from Commander.zdiffBuffer
- Defined in utils/RedisCommander.ts:12431
zdiffBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Inherited from Commander.zdiffBuffer
- Defined in utils/RedisCommander.ts:12445
zdiffBuffer(
...args: [numkeys: string | number, ...keys: RedisKey[]],
): Promise<Buffer[]>
Parameters
- ...args: [numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<Buffer[]>
Inherited from Commander.zdiffBuffer
- Defined in utils/RedisCommander.ts:12455
zdiffBuffer(
...args: [numkeys: string | number, keys: RedisKey[]],
): Promise<Buffer[]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[]]
Returns Promise<Buffer[]>
Inherited from Commander.zdiffBuffer
- Defined in utils/RedisCommander.ts:12461
zdiffBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        withscores: "WITHSCORES",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      withscores: "WITHSCORES",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zdiffBuffer
- Defined in utils/RedisCommander.ts:12472
zdiffBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        withscores: "WITHSCORES",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      withscores: "WITHSCORES",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zdiffBuffer
- Defined in utils/RedisCommander.ts:12488
zdiffBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        withscores: "WITHSCORES",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Inherited from Commander.zdiffBuffer
- Defined in utils/RedisCommander.ts:12503
zdiffBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        withscores: "WITHSCORES",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Inherited from Commander.zdiffBuffer
- Defined in utils/RedisCommander.ts:12517

zdiffstore

zdiffstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...keys: RedisKey[],
        callback: Callback<number>,
    ],
): Promise<number>
Stores the difference of multiple sorted sets in a key.
- group: sorted-set
- complexity: O(L + (N-K)log(N)) worst case where L is the total number of elements in all the sets, N is the size of the first set, and K is the size of the result set.
- since: 6.2.0
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      ...keys: RedisKey[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zdiffstore
- Defined in utils/RedisCommander.ts:12531
zdiffstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        keys: RedisKey[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      keys: RedisKey[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zdiffstore
- Defined in utils/RedisCommander.ts:12539
zdiffstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...keys: RedisKey[],
    ],
): Promise<number>
Parameters
- ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<number>
Inherited from Commander.zdiffstore
- Defined in utils/RedisCommander.ts:12547
zdiffstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        keys: RedisKey[],
    ],
): Promise<number>
Parameters
- ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[]]
Returns Promise<number>
Inherited from Commander.zdiffstore
- Defined in utils/RedisCommander.ts:12554

zincrby

zincrby(
    key: RedisKey,
    increment: string | number,
    member: string | number | Buffer,
    callback?: Callback<string>,
): Promise<string>
Increments the score of a member in a sorted set.
- group: sorted-set
- complexity: O(log(N)) where N is the number of elements in the sorted set.
- since: 1.2.0
Parameters
- key: RedisKey
- increment: string | number
- member: string | number | Buffer
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.zincrby
- Defined in utils/RedisCommander.ts:12564

zincrbyBuffer

zincrbyBuffer(
    key: RedisKey,
    increment: string | number,
    member: string | number | Buffer,
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- increment: string | number
- member: string | number | Buffer
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.zincrbyBuffer
- Defined in utils/RedisCommander.ts:12570

zinter

zinter(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Returns the intersect of multiple sorted sets.
- group: sorted-set
- complexity: O(NK)+O(Mlog(M)) worst case with N being the smallest input sorted set, K being the number of input sorted sets and M being the number of elements in the resulting sorted set.
- since: 6.2.0
Parameters
- ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:12583
zinter(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:12597
zinter(
...args: [numkeys: string | number, ...keys: RedisKey[]],
): Promise<string[]>
Parameters
- ...args: [numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:12611
zinter(...args: [numkeys: string | number, keys: RedisKey[]]): Promise<string[]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[]]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:12617
zinter(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        withscores: "WITHSCORES",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      withscores: "WITHSCORES",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:12623
zinter(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        withscores: "WITHSCORES",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      withscores: "WITHSCORES",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:12639
zinter(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        withscores: "WITHSCORES",
    ],
): Promise<string[]>
Parameters
- ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:12655
zinter(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        withscores: "WITHSCORES",
    ],
): Promise<string[]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:12669
zinter(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:12683
zinter(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:12701
zinter(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:12719
zinter(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
    ],
): Promise<string[]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:12735
zinter(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        withscores: "WITHSCORES",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      withscores: "WITHSCORES",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:12751
zinter(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        withscores: "WITHSCORES",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      withscores: "WITHSCORES",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:12771
zinter(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        withscores: "WITHSCORES",
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      withscores: "WITHSCORES",
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:12791
zinter(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        withscores: "WITHSCORES",
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      withscores: "WITHSCORES",
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:12809
zinter(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:12827
zinter(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:12845
zinter(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:12863
zinter(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
    ],
): Promise<string[]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:12879
zinter(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
        withscores: "WITHSCORES",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
      withscores: "WITHSCORES",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:12895
zinter(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
        withscores: "WITHSCORES",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
      withscores: "WITHSCORES",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:12915
zinter(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
        withscores: "WITHSCORES",
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
      withscores: "WITHSCORES",
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:12935
zinter(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
        withscores: "WITHSCORES",
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
      withscores: "WITHSCORES",
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:12953
zinter(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:12971
zinter(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:12989
zinter(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:13007
zinter(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
    ],
): Promise<string[]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:13023
zinter(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
        withscores: "WITHSCORES",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
      withscores: "WITHSCORES",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:13039
zinter(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
        withscores: "WITHSCORES",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
      withscores: "WITHSCORES",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:13059
zinter(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
        withscores: "WITHSCORES",
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
      withscores: "WITHSCORES",
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:13079
zinter(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
        withscores: "WITHSCORES",
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
      withscores: "WITHSCORES",
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:13097
zinter(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [numkeys: string | number, ...args: RedisValue[], callback: Callback<string[]>]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:13115
zinter(
...args: [numkeys: string | number, ...args: RedisValue[]],
): Promise<string[]>
Parameters
- ...args: [numkeys: string | number, ...args: RedisValue[]]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:13129
zinter(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        withscores: "WITHSCORES",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      withscores: "WITHSCORES",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:13135
zinter(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        withscores: "WITHSCORES",
    ],
): Promise<string[]>
Parameters
- ...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES"]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:13151
zinter(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:13165
zinter(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        sum: "SUM",
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      sum: "SUM",
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:13183
zinter(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        withscores: "WITHSCORES",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      withscores: "WITHSCORES",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:13199
zinter(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        withscores: "WITHSCORES",
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      withscores: "WITHSCORES",
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:13219
zinter(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        min: "MIN",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      min: "MIN",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:13237
zinter(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        min: "MIN",
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      min: "MIN",
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:13255
zinter(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        min: "MIN",
        withscores: "WITHSCORES",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      min: "MIN",
      withscores: "WITHSCORES",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:13271
zinter(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        min: "MIN",
        withscores: "WITHSCORES",
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      min: "MIN",
      withscores: "WITHSCORES",
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:13291
zinter(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        max: "MAX",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      max: "MAX",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:13309
zinter(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        max: "MAX",
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      max: "MAX",
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:13327
zinter(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        max: "MAX",
        withscores: "WITHSCORES",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      max: "MAX",
      withscores: "WITHSCORES",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:13343
zinter(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        max: "MAX",
        withscores: "WITHSCORES",
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      max: "MAX",
      withscores: "WITHSCORES",
  ]
Returns Promise<string[]>
Inherited from Commander.zinter
- Defined in utils/RedisCommander.ts:13363

zinterBuffer

zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:12590
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:12604
zinterBuffer(
...args: [numkeys: string | number, ...keys: RedisKey[]],
): Promise<Buffer[]>
Parameters
- ...args: [numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:12614
zinterBuffer(
...args: [numkeys: string | number, keys: RedisKey[]],
): Promise<Buffer[]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[]]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:12620
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        withscores: "WITHSCORES",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      withscores: "WITHSCORES",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:12631
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        withscores: "WITHSCORES",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      withscores: "WITHSCORES",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:12647
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        withscores: "WITHSCORES",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:12662
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        withscores: "WITHSCORES",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:12676
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:12692
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:12710
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:12727
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:12743
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        withscores: "WITHSCORES",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      withscores: "WITHSCORES",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:12761
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        withscores: "WITHSCORES",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      withscores: "WITHSCORES",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:12781
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        withscores: "WITHSCORES",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      withscores: "WITHSCORES",
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:12800
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        withscores: "WITHSCORES",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      withscores: "WITHSCORES",
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:12818
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:12836
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:12854
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:12871
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:12887
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
        withscores: "WITHSCORES",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
      withscores: "WITHSCORES",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:12905
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
        withscores: "WITHSCORES",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
      withscores: "WITHSCORES",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:12925
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
        withscores: "WITHSCORES",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
      withscores: "WITHSCORES",
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:12944
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
        withscores: "WITHSCORES",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
      withscores: "WITHSCORES",
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:12962
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:12980
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:12998
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:13015
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:13031
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
        withscores: "WITHSCORES",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
      withscores: "WITHSCORES",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:13049
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
        withscores: "WITHSCORES",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
      withscores: "WITHSCORES",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:13069
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
        withscores: "WITHSCORES",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
      withscores: "WITHSCORES",
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:13088
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
        withscores: "WITHSCORES",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
      withscores: "WITHSCORES",
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:13106
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [numkeys: string | number, ...args: RedisValue[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:13122
zinterBuffer(
...args: [numkeys: string | number, ...args: RedisValue[]],
): Promise<Buffer[]>
Parameters
- ...args: [numkeys: string | number, ...args: RedisValue[]]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:13132
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        withscores: "WITHSCORES",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      withscores: "WITHSCORES",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:13143
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        withscores: "WITHSCORES",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:13158
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:13174
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        sum: "SUM",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      sum: "SUM",
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:13191
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        withscores: "WITHSCORES",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      withscores: "WITHSCORES",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:13209
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        withscores: "WITHSCORES",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      withscores: "WITHSCORES",
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:13228
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        min: "MIN",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      min: "MIN",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:13246
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        min: "MIN",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      min: "MIN",
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:13263
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        min: "MIN",
        withscores: "WITHSCORES",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      min: "MIN",
      withscores: "WITHSCORES",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:13281
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        min: "MIN",
        withscores: "WITHSCORES",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      min: "MIN",
      withscores: "WITHSCORES",
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:13300
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        max: "MAX",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      max: "MAX",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:13318
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        max: "MAX",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      max: "MAX",
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:13335
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        max: "MAX",
        withscores: "WITHSCORES",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      max: "MAX",
      withscores: "WITHSCORES",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:13353
zinterBuffer(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        max: "MAX",
        withscores: "WITHSCORES",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      max: "MAX",
      withscores: "WITHSCORES",
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zinterBuffer
- Defined in utils/RedisCommander.ts:13372

zintercard

zintercard(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        callback: Callback<number>,
    ],
): Promise<number>
Returns the number of members of the intersect of multiple sorted sets.
- group: sorted-set
- complexity: O(N*K) worst case with N being the smallest input sorted set, K being the number of input sorted sets.
- since: 7.0.0
Parameters
- ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Inherited from Commander.zintercard
- Defined in utils/RedisCommander.ts:13388
zintercard(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<number>]
Returns Promise<number>
Inherited from Commander.zintercard
- Defined in utils/RedisCommander.ts:13395
zintercard(
...args: [numkeys: string | number, ...keys: RedisKey[]],
): Promise<number>
Parameters
- ...args: [numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<number>
Inherited from Commander.zintercard
- Defined in utils/RedisCommander.ts:13402
zintercard(
...args: [numkeys: string | number, keys: RedisKey[]],
): Promise<number>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[]]
Returns Promise<number>
Inherited from Commander.zintercard
- Defined in utils/RedisCommander.ts:13405
zintercard(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        limitToken: "LIMIT",
        limit: string | number,
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      limitToken: "LIMIT",
      limit: string | number,
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zintercard
- Defined in utils/RedisCommander.ts:13408
zintercard(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        limitToken: "LIMIT",
        limit: string | number,
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      limitToken: "LIMIT",
      limit: string | number,
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zintercard
- Defined in utils/RedisCommander.ts:13417
zintercard(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        limitToken: "LIMIT",
        limit: string | number,
    ],
): Promise<number>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      limitToken: "LIMIT",
      limit: string | number,
  ]
Returns Promise<number>
Inherited from Commander.zintercard
- Defined in utils/RedisCommander.ts:13426
zintercard(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        limitToken: "LIMIT",
        limit: string | number,
    ],
): Promise<number>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      limitToken: "LIMIT",
      limit: string | number,
  ]
Returns Promise<number>
Inherited from Commander.zintercard
- Defined in utils/RedisCommander.ts:13434

zinterstore

zinterstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...keys: RedisKey[],
        callback: Callback<number>,
    ],
): Promise<number>
Stores the intersect of multiple sorted sets in a key.
- group: sorted-set
- complexity: O(NK)+O(Mlog(M)) worst case with N being the smallest input sorted set, K being the number of input sorted sets and M being the number of elements in the resulting sorted set.
- since: 2.0.0
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      ...keys: RedisKey[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zinterstore
- Defined in utils/RedisCommander.ts:13449
zinterstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        keys: RedisKey[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      keys: RedisKey[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zinterstore
- Defined in utils/RedisCommander.ts:13457
zinterstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...keys: RedisKey[],
    ],
): Promise<number>
Parameters
- ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<number>
Inherited from Commander.zinterstore
- Defined in utils/RedisCommander.ts:13465
zinterstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        keys: RedisKey[],
    ],
): Promise<number>
Parameters
- ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[]]
Returns Promise<number>
Inherited from Commander.zinterstore
- Defined in utils/RedisCommander.ts:13472
zinterstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zinterstore
- Defined in utils/RedisCommander.ts:13475
zinterstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zinterstore
- Defined in utils/RedisCommander.ts:13485
zinterstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
  ]
Returns Promise<number>
Inherited from Commander.zinterstore
- Defined in utils/RedisCommander.ts:13495
zinterstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
  ]
Returns Promise<number>
Inherited from Commander.zinterstore
- Defined in utils/RedisCommander.ts:13504
zinterstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zinterstore
- Defined in utils/RedisCommander.ts:13513
zinterstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zinterstore
- Defined in utils/RedisCommander.ts:13523
zinterstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
  ]
Returns Promise<number>
Inherited from Commander.zinterstore
- Defined in utils/RedisCommander.ts:13533
zinterstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
  ]
Returns Promise<number>
Inherited from Commander.zinterstore
- Defined in utils/RedisCommander.ts:13542
zinterstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zinterstore
- Defined in utils/RedisCommander.ts:13551
zinterstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zinterstore
- Defined in utils/RedisCommander.ts:13561
zinterstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
  ]
Returns Promise<number>
Inherited from Commander.zinterstore
- Defined in utils/RedisCommander.ts:13571
zinterstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
  ]
Returns Promise<number>
Inherited from Commander.zinterstore
- Defined in utils/RedisCommander.ts:13580
zinterstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...args: RedisValue[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      ...args: RedisValue[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zinterstore
- Defined in utils/RedisCommander.ts:13589
zinterstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...args: RedisValue[],
    ],
): Promise<number>
Parameters
- ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[]]
Returns Promise<number>
Inherited from Commander.zinterstore
- Defined in utils/RedisCommander.ts:13597
zinterstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zinterstore
- Defined in utils/RedisCommander.ts:13604
zinterstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        sum: "SUM",
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      sum: "SUM",
  ]
Returns Promise<number>
Inherited from Commander.zinterstore
- Defined in utils/RedisCommander.ts:13614
zinterstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        min: "MIN",
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      min: "MIN",
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zinterstore
- Defined in utils/RedisCommander.ts:13623
zinterstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        min: "MIN",
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      min: "MIN",
  ]
Returns Promise<number>
Inherited from Commander.zinterstore
- Defined in utils/RedisCommander.ts:13633
zinterstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        max: "MAX",
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      max: "MAX",
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zinterstore
- Defined in utils/RedisCommander.ts:13642
zinterstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        max: "MAX",
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      max: "MAX",
  ]
Returns Promise<number>
Inherited from Commander.zinterstore
- Defined in utils/RedisCommander.ts:13652

zlexcount

zlexcount(
    key: RedisKey,
    min: string | number | Buffer,
    max: string | number | Buffer,
    callback?: Callback<number>,
): Promise<number>
Returns the number of members in a sorted set within a lexicographical range.
- group: sorted-set
- complexity: O(log(N)) with N being the number of elements in the sorted set.
- since: 2.8.9
Parameters
- key: RedisKey
- min: string | number | Buffer
- max: string | number | Buffer
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.zlexcount
- Defined in utils/RedisCommander.ts:13668

zmpop

zmpop(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        min: "MIN",
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Returns the highest- or lowest-scoring members from one or more sorted sets after removing them. Deletes the sorted set if the last member was popped.
- group: sorted-set
- complexity: O(K) + O(M*log(N)) where K is the number of provided keys, N being the number of elements in the sorted set, and M being the number of elements popped.
- since: 7.0.0
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      min: "MIN",
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.zmpop
- Defined in utils/RedisCommander.ts:13681
zmpop(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        min: "MIN",
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      min: "MIN",
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.zmpop
- Defined in utils/RedisCommander.ts:13689
zmpop(
...args: [numkeys: string | number, ...keys: RedisKey[], min: "MIN"],
): Promise<unknown>
Parameters
- ...args: [numkeys: string | number, ...keys: RedisKey[], min: "MIN"]
Returns Promise<unknown>
Inherited from Commander.zmpop
- Defined in utils/RedisCommander.ts:13697
zmpop(
...args: [numkeys: string | number, keys: RedisKey[], min: "MIN"],
): Promise<unknown>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[], min: "MIN"]
Returns Promise<unknown>
Inherited from Commander.zmpop
- Defined in utils/RedisCommander.ts:13700
zmpop(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        min: "MIN",
        countToken: "COUNT",
        count: string | number,
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      min: "MIN",
      countToken: "COUNT",
      count: string | number,
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.zmpop
- Defined in utils/RedisCommander.ts:13703
zmpop(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        min: "MIN",
        countToken: "COUNT",
        count: string | number,
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      min: "MIN",
      countToken: "COUNT",
      count: string | number,
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.zmpop
- Defined in utils/RedisCommander.ts:13713
zmpop(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        min: "MIN",
        countToken: "COUNT",
        count: string | number,
    ],
): Promise<unknown>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      min: "MIN",
      countToken: "COUNT",
      count: string | number,
  ]
Returns Promise<unknown>
Inherited from Commander.zmpop
- Defined in utils/RedisCommander.ts:13723
zmpop(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        min: "MIN",
        countToken: "COUNT",
        count: string | number,
    ],
): Promise<unknown>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      min: "MIN",
      countToken: "COUNT",
      count: string | number,
  ]
Returns Promise<unknown>
Inherited from Commander.zmpop
- Defined in utils/RedisCommander.ts:13732
zmpop(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        max: "MAX",
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      max: "MAX",
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.zmpop
- Defined in utils/RedisCommander.ts:13741
zmpop(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        max: "MAX",
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      max: "MAX",
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.zmpop
- Defined in utils/RedisCommander.ts:13749
zmpop(
...args: [numkeys: string | number, ...keys: RedisKey[], max: "MAX"],
): Promise<unknown>
Parameters
- ...args: [numkeys: string | number, ...keys: RedisKey[], max: "MAX"]
Returns Promise<unknown>
Inherited from Commander.zmpop
- Defined in utils/RedisCommander.ts:13757
zmpop(
...args: [numkeys: string | number, keys: RedisKey[], max: "MAX"],
): Promise<unknown>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[], max: "MAX"]
Returns Promise<unknown>
Inherited from Commander.zmpop
- Defined in utils/RedisCommander.ts:13760
zmpop(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        max: "MAX",
        countToken: "COUNT",
        count: string | number,
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      max: "MAX",
      countToken: "COUNT",
      count: string | number,
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.zmpop
- Defined in utils/RedisCommander.ts:13763
zmpop(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        max: "MAX",
        countToken: "COUNT",
        count: string | number,
        callback: Callback<unknown>,
    ],
): Promise<unknown>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      max: "MAX",
      countToken: "COUNT",
      count: string | number,
      callback: Callback<unknown>,
  ]
Returns Promise<unknown>
Inherited from Commander.zmpop
- Defined in utils/RedisCommander.ts:13773
zmpop(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        max: "MAX",
        countToken: "COUNT",
        count: string | number,
    ],
): Promise<unknown>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      max: "MAX",
      countToken: "COUNT",
      count: string | number,
  ]
Returns Promise<unknown>
Inherited from Commander.zmpop
- Defined in utils/RedisCommander.ts:13783
zmpop(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        max: "MAX",
        countToken: "COUNT",
        count: string | number,
    ],
): Promise<unknown>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      max: "MAX",
      countToken: "COUNT",
      count: string | number,
  ]
Returns Promise<unknown>
Inherited from Commander.zmpop
- Defined in utils/RedisCommander.ts:13792

zmscore

zmscore(
    ...args: [
        key: RedisKey,
        ...members: (string | number | Buffer)[],
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Returns the score of one or more members in a sorted set.
- group: sorted-set
- complexity: O(N) where N is the number of members being requested.
- since: 6.2.0
Parameters
- ...args: [
      key: RedisKey,
      ...members: (string | number | Buffer)[],
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zmscore
- Defined in utils/RedisCommander.ts:13808
zmscore(
    ...args: [
        key: RedisKey,
        members: (string | number | Buffer)[],
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      key: RedisKey,
      members: (string | number | Buffer)[],
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zmscore
- Defined in utils/RedisCommander.ts:13822
zmscore(
...args: [key: RedisKey, ...members: (string | number | Buffer)[]],
): Promise<string[]>
Parameters
- ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns Promise<string[]>
Inherited from Commander.zmscore
- Defined in utils/RedisCommander.ts:13836
zmscore(
...args: [key: RedisKey, members: (string | number | Buffer)[]],
): Promise<string[]>
Parameters
- ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns Promise<string[]>
Inherited from Commander.zmscore
- Defined in utils/RedisCommander.ts:13842

zmscoreBuffer

zmscoreBuffer(
    ...args: [
        key: RedisKey,
        ...members: (string | number | Buffer)[],
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      key: RedisKey,
      ...members: (string | number | Buffer)[],
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zmscoreBuffer
- Defined in utils/RedisCommander.ts:13815
zmscoreBuffer(
    ...args: [
        key: RedisKey,
        members: (string | number | Buffer)[],
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      key: RedisKey,
      members: (string | number | Buffer)[],
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zmscoreBuffer
- Defined in utils/RedisCommander.ts:13829
zmscoreBuffer(
...args: [key: RedisKey, ...members: (string | number | Buffer)[]],
): Promise<Buffer[]>
Parameters
- ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns Promise<Buffer[]>
Inherited from Commander.zmscoreBuffer
- Defined in utils/RedisCommander.ts:13839
zmscoreBuffer(
...args: [key: RedisKey, members: (string | number | Buffer)[]],
): Promise<Buffer[]>
Parameters
- ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns Promise<Buffer[]>
Inherited from Commander.zmscoreBuffer
- Defined in utils/RedisCommander.ts:13845

zpopmax

zpopmax(key: RedisKey, callback?: Callback<string[]>): Promise<string[]>
Returns the highest-scoring members from a sorted set after removing them. Deletes the sorted set if the last member was popped.
- group: sorted-set
- complexity: O(log(N)*M) with N being the number of elements in the sorted set, and M being the number of elements popped.
- since: 5.0.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zpopmax
- Defined in utils/RedisCommander.ts:13855
zpopmax(
    key: RedisKey,
    count: string | number,
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- count: string | number
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zpopmax
- Defined in utils/RedisCommander.ts:13863

zpopmaxBuffer

zpopmaxBuffer(key: RedisKey, callback?: Callback<Buffer[]>): Promise<Buffer[]>
Parameters
- key: RedisKey
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zpopmaxBuffer
- Defined in utils/RedisCommander.ts:13859
zpopmaxBuffer(
    key: RedisKey,
    count: string | number,
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- count: string | number
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zpopmaxBuffer
- Defined in utils/RedisCommander.ts:13868

zpopmin

zpopmin(key: RedisKey, callback?: Callback<string[]>): Promise<string[]>
Returns the lowest-scoring members from a sorted set after removing them. Deletes the sorted set if the last member was popped.
- group: sorted-set
- complexity: O(log(N)*M) with N being the number of elements in the sorted set, and M being the number of elements popped.
- since: 5.0.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zpopmin
- Defined in utils/RedisCommander.ts:13880
zpopmin(
    key: RedisKey,
    count: string | number,
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- count: string | number
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zpopmin
- Defined in utils/RedisCommander.ts:13888

zpopminBuffer

zpopminBuffer(key: RedisKey, callback?: Callback<Buffer[]>): Promise<Buffer[]>
Parameters
- key: RedisKey
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zpopminBuffer
- Defined in utils/RedisCommander.ts:13884
zpopminBuffer(
    key: RedisKey,
    count: string | number,
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- count: string | number
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zpopminBuffer
- Defined in utils/RedisCommander.ts:13893

zrandmember

zrandmember(key: RedisKey, callback?: Callback<string>): Promise<string>
Returns one or more random members from a sorted set.
- group: sorted-set
- complexity: O(N) where N is the number of members returned
- since: 6.2.0
Parameters
- key: RedisKey
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.zrandmember
- Defined in utils/RedisCommander.ts:13905
zrandmember(
    key: RedisKey,
    count: string | number,
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- count: string | number
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrandmember
- Defined in utils/RedisCommander.ts:13913
zrandmember(
    key: RedisKey,
    count: string | number,
    withscores: "WITHSCORES",
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- count: string | number
- withscores: "WITHSCORES"
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrandmember
- Defined in utils/RedisCommander.ts:13923

zrandmemberBuffer

zrandmemberBuffer(key: RedisKey, callback?: Callback<Buffer>): Promise<Buffer>
Parameters
- key: RedisKey
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.zrandmemberBuffer
- Defined in utils/RedisCommander.ts:13909
zrandmemberBuffer(
    key: RedisKey,
    count: string | number,
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- count: string | number
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrandmemberBuffer
- Defined in utils/RedisCommander.ts:13918
zrandmemberBuffer(
    key: RedisKey,
    count: string | number,
    withscores: "WITHSCORES",
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- count: string | number
- withscores: "WITHSCORES"
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrandmemberBuffer
- Defined in utils/RedisCommander.ts:13929

zrange

zrange(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    callback?: Callback<string[]>,
): Promise<string[]>
Returns members in a sorted set within a range of indexes.
- group: sorted-set
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements returned.
- since: 1.2.0
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrange
- Defined in utils/RedisCommander.ts:13942
zrange(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    withscores: "WITHSCORES",
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- withscores: "WITHSCORES"
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrange
- Defined in utils/RedisCommander.ts:13954
zrange(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrange
- Defined in utils/RedisCommander.ts:13968
zrange(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    withscores: "WITHSCORES",
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- withscores: "WITHSCORES"
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrange
- Defined in utils/RedisCommander.ts:13986
zrange(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    rev: "REV",
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- rev: "REV"
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrange
- Defined in utils/RedisCommander.ts:14006
zrange(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    rev: "REV",
    withscores: "WITHSCORES",
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- rev: "REV"
- withscores: "WITHSCORES"
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrange
- Defined in utils/RedisCommander.ts:14020
zrange(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    rev: "REV",
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- rev: "REV"
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrange
- Defined in utils/RedisCommander.ts:14036
zrange(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    rev: "REV",
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    withscores: "WITHSCORES",
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- rev: "REV"
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- withscores: "WITHSCORES"
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrange
- Defined in utils/RedisCommander.ts:14056
zrange(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    byscore: "BYSCORE",
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- byscore: "BYSCORE"
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrange
- Defined in utils/RedisCommander.ts:14078
zrange(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    byscore: "BYSCORE",
    withscores: "WITHSCORES",
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- byscore: "BYSCORE"
- withscores: "WITHSCORES"
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrange
- Defined in utils/RedisCommander.ts:14092
zrange(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    byscore: "BYSCORE",
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- byscore: "BYSCORE"
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrange
- Defined in utils/RedisCommander.ts:14108
zrange(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    byscore: "BYSCORE",
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    withscores: "WITHSCORES",
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- byscore: "BYSCORE"
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- withscores: "WITHSCORES"
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrange
- Defined in utils/RedisCommander.ts:14128
zrange(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    byscore: "BYSCORE",
    rev: "REV",
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- byscore: "BYSCORE"
- rev: "REV"
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrange
- Defined in utils/RedisCommander.ts:14150
zrange(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    byscore: "BYSCORE",
    rev: "REV",
    withscores: "WITHSCORES",
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- byscore: "BYSCORE"
- rev: "REV"
- withscores: "WITHSCORES"
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrange
- Defined in utils/RedisCommander.ts:14166
zrange(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    byscore: "BYSCORE",
    rev: "REV",
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- byscore: "BYSCORE"
- rev: "REV"
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrange
- Defined in utils/RedisCommander.ts:14184
zrange(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    byscore: "BYSCORE",
    rev: "REV",
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    withscores: "WITHSCORES",
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- byscore: "BYSCORE"
- rev: "REV"
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- withscores: "WITHSCORES"
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrange
- Defined in utils/RedisCommander.ts:14206
zrange(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    bylex: "BYLEX",
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- bylex: "BYLEX"
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrange
- Defined in utils/RedisCommander.ts:14230
zrange(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    bylex: "BYLEX",
    withscores: "WITHSCORES",
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- bylex: "BYLEX"
- withscores: "WITHSCORES"
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrange
- Defined in utils/RedisCommander.ts:14244
zrange(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    bylex: "BYLEX",
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- bylex: "BYLEX"
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrange
- Defined in utils/RedisCommander.ts:14260
zrange(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    bylex: "BYLEX",
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    withscores: "WITHSCORES",
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- bylex: "BYLEX"
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- withscores: "WITHSCORES"
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrange
- Defined in utils/RedisCommander.ts:14280
zrange(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    bylex: "BYLEX",
    rev: "REV",
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- bylex: "BYLEX"
- rev: "REV"
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrange
- Defined in utils/RedisCommander.ts:14302
zrange(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    bylex: "BYLEX",
    rev: "REV",
    withscores: "WITHSCORES",
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- bylex: "BYLEX"
- rev: "REV"
- withscores: "WITHSCORES"
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrange
- Defined in utils/RedisCommander.ts:14318
zrange(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    bylex: "BYLEX",
    rev: "REV",
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- bylex: "BYLEX"
- rev: "REV"
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrange
- Defined in utils/RedisCommander.ts:14336
zrange(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    bylex: "BYLEX",
    rev: "REV",
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    withscores: "WITHSCORES",
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- bylex: "BYLEX"
- rev: "REV"
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- withscores: "WITHSCORES"
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrange
- Defined in utils/RedisCommander.ts:14358

zrangeBuffer

zrangeBuffer(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrangeBuffer
- Defined in utils/RedisCommander.ts:13948
zrangeBuffer(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    withscores: "WITHSCORES",
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- withscores: "WITHSCORES"
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrangeBuffer
- Defined in utils/RedisCommander.ts:13961
zrangeBuffer(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrangeBuffer
- Defined in utils/RedisCommander.ts:13977
zrangeBuffer(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    withscores: "WITHSCORES",
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- withscores: "WITHSCORES"
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrangeBuffer
- Defined in utils/RedisCommander.ts:13996
zrangeBuffer(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    rev: "REV",
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- rev: "REV"
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrangeBuffer
- Defined in utils/RedisCommander.ts:14013
zrangeBuffer(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    rev: "REV",
    withscores: "WITHSCORES",
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- rev: "REV"
- withscores: "WITHSCORES"
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrangeBuffer
- Defined in utils/RedisCommander.ts:14028
zrangeBuffer(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    rev: "REV",
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- rev: "REV"
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrangeBuffer
- Defined in utils/RedisCommander.ts:14046
zrangeBuffer(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    rev: "REV",
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    withscores: "WITHSCORES",
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- rev: "REV"
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- withscores: "WITHSCORES"
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrangeBuffer
- Defined in utils/RedisCommander.ts:14067
zrangeBuffer(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    byscore: "BYSCORE",
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- byscore: "BYSCORE"
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrangeBuffer
- Defined in utils/RedisCommander.ts:14085
zrangeBuffer(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    byscore: "BYSCORE",
    withscores: "WITHSCORES",
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- byscore: "BYSCORE"
- withscores: "WITHSCORES"
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrangeBuffer
- Defined in utils/RedisCommander.ts:14100
zrangeBuffer(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    byscore: "BYSCORE",
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- byscore: "BYSCORE"
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrangeBuffer
- Defined in utils/RedisCommander.ts:14118
zrangeBuffer(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    byscore: "BYSCORE",
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    withscores: "WITHSCORES",
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- byscore: "BYSCORE"
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- withscores: "WITHSCORES"
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrangeBuffer
- Defined in utils/RedisCommander.ts:14139
zrangeBuffer(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    byscore: "BYSCORE",
    rev: "REV",
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- byscore: "BYSCORE"
- rev: "REV"
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrangeBuffer
- Defined in utils/RedisCommander.ts:14158
zrangeBuffer(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    byscore: "BYSCORE",
    rev: "REV",
    withscores: "WITHSCORES",
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- byscore: "BYSCORE"
- rev: "REV"
- withscores: "WITHSCORES"
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrangeBuffer
- Defined in utils/RedisCommander.ts:14175
zrangeBuffer(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    byscore: "BYSCORE",
    rev: "REV",
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- byscore: "BYSCORE"
- rev: "REV"
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrangeBuffer
- Defined in utils/RedisCommander.ts:14195
zrangeBuffer(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    byscore: "BYSCORE",
    rev: "REV",
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    withscores: "WITHSCORES",
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- byscore: "BYSCORE"
- rev: "REV"
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- withscores: "WITHSCORES"
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrangeBuffer
- Defined in utils/RedisCommander.ts:14218
zrangeBuffer(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    bylex: "BYLEX",
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- bylex: "BYLEX"
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrangeBuffer
- Defined in utils/RedisCommander.ts:14237
zrangeBuffer(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    bylex: "BYLEX",
    withscores: "WITHSCORES",
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- bylex: "BYLEX"
- withscores: "WITHSCORES"
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrangeBuffer
- Defined in utils/RedisCommander.ts:14252
zrangeBuffer(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    bylex: "BYLEX",
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- bylex: "BYLEX"
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrangeBuffer
- Defined in utils/RedisCommander.ts:14270
zrangeBuffer(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    bylex: "BYLEX",
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    withscores: "WITHSCORES",
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- bylex: "BYLEX"
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- withscores: "WITHSCORES"
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrangeBuffer
- Defined in utils/RedisCommander.ts:14291
zrangeBuffer(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    bylex: "BYLEX",
    rev: "REV",
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- bylex: "BYLEX"
- rev: "REV"
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrangeBuffer
- Defined in utils/RedisCommander.ts:14310
zrangeBuffer(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    bylex: "BYLEX",
    rev: "REV",
    withscores: "WITHSCORES",
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- bylex: "BYLEX"
- rev: "REV"
- withscores: "WITHSCORES"
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrangeBuffer
- Defined in utils/RedisCommander.ts:14327
zrangeBuffer(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    bylex: "BYLEX",
    rev: "REV",
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- bylex: "BYLEX"
- rev: "REV"
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrangeBuffer
- Defined in utils/RedisCommander.ts:14347
zrangeBuffer(
    key: RedisKey,
    start: string | number | Buffer,
    stop: string | Buffer,
    bylex: "BYLEX",
    rev: "REV",
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    withscores: "WITHSCORES",
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- start: string | number | Buffer
- stop: string | Buffer
- bylex: "BYLEX"
- rev: "REV"
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- withscores: "WITHSCORES"
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrangeBuffer
- Defined in utils/RedisCommander.ts:14370

zrangebylex

zrangebylex(
    key: RedisKey,
    min: string | number | Buffer,
    max: string | number | Buffer,
    callback?: Callback<string[]>,
): Promise<string[]>
Returns members in a sorted set within a lexicographical range.
- group: sorted-set
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements being returned. If M is constant (e.g. always asking for the first 10 elements with LIMIT), you can consider it O(log(N)).
- since: 2.8.9
Parameters
- key: RedisKey
- min: string | number | Buffer
- max: string | number | Buffer
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrangebylex
- Defined in utils/RedisCommander.ts:14389
zrangebylex(
    key: RedisKey,
    min: string | number | Buffer,
    max: string | number | Buffer,
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- min: string | number | Buffer
- max: string | number | Buffer
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrangebylex
- Defined in utils/RedisCommander.ts:14401

zrangebylexBuffer

zrangebylexBuffer(
    key: RedisKey,
    min: string | number | Buffer,
    max: string | number | Buffer,
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- min: string | number | Buffer
- max: string | number | Buffer
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrangebylexBuffer
- Defined in utils/RedisCommander.ts:14395
zrangebylexBuffer(
    key: RedisKey,
    min: string | number | Buffer,
    max: string | number | Buffer,
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- min: string | number | Buffer
- max: string | number | Buffer
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrangebylexBuffer
- Defined in utils/RedisCommander.ts:14410

zrangebyscore

zrangebyscore(
    key: RedisKey,
    min: string | number,
    max: string | number,
    callback?: Callback<string[]>,
): Promise<string[]>
Returns members in a sorted set within a range of scores.
- group: sorted-set
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements being returned. If M is constant (e.g. always asking for the first 10 elements with LIMIT), you can consider it O(log(N)).
- since: 1.0.5
Parameters
- key: RedisKey
- min: string | number
- max: string | number
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrangebyscore
- Defined in utils/RedisCommander.ts:14426
zrangebyscore(
    key: RedisKey,
    min: string | number,
    max: string | number,
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- min: string | number
- max: string | number
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrangebyscore
- Defined in utils/RedisCommander.ts:14438
zrangebyscore(
    key: RedisKey,
    min: string | number,
    max: string | number,
    withscores: "WITHSCORES",
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- min: string | number
- max: string | number
- withscores: "WITHSCORES"
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrangebyscore
- Defined in utils/RedisCommander.ts:14456
zrangebyscore(
    key: RedisKey,
    min: string | number,
    max: string | number,
    withscores: "WITHSCORES",
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- min: string | number
- max: string | number
- withscores: "WITHSCORES"
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrangebyscore
- Defined in utils/RedisCommander.ts:14470

zrangebyscoreBuffer

zrangebyscoreBuffer(
    key: RedisKey,
    min: string | number,
    max: string | number,
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- min: string | number
- max: string | number
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrangebyscoreBuffer
- Defined in utils/RedisCommander.ts:14432
zrangebyscoreBuffer(
    key: RedisKey,
    min: string | number,
    max: string | number,
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- min: string | number
- max: string | number
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrangebyscoreBuffer
- Defined in utils/RedisCommander.ts:14447
zrangebyscoreBuffer(
    key: RedisKey,
    min: string | number,
    max: string | number,
    withscores: "WITHSCORES",
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- min: string | number
- max: string | number
- withscores: "WITHSCORES"
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrangebyscoreBuffer
- Defined in utils/RedisCommander.ts:14463
zrangebyscoreBuffer(
    key: RedisKey,
    min: string | number,
    max: string | number,
    withscores: "WITHSCORES",
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- min: string | number
- max: string | number
- withscores: "WITHSCORES"
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrangebyscoreBuffer
- Defined in utils/RedisCommander.ts:14480

zrangestore

zrangestore(
    dst: RedisKey,
    src: RedisKey,
    min: string | number | Buffer,
    max: string | number | Buffer,
    callback?: Callback<number>,
): Promise<number>
Stores a range of members from sorted set in a key.
- group: sorted-set
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements stored into the destination key.
- since: 6.2.0
Parameters
- dst: RedisKey
- src: RedisKey
- min: string | number | Buffer
- max: string | number | Buffer
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.zrangestore
- Defined in utils/RedisCommander.ts:14497
zrangestore(
    dst: RedisKey,
    src: RedisKey,
    min: string | number | Buffer,
    max: string | number | Buffer,
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    callback?: Callback<number>,
): Promise<number>
Parameters
- dst: RedisKey
- src: RedisKey
- min: string | number | Buffer
- max: string | number | Buffer
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.zrangestore
- Defined in utils/RedisCommander.ts:14504
zrangestore(
    dst: RedisKey,
    src: RedisKey,
    min: string | number | Buffer,
    max: string | number | Buffer,
    rev: "REV",
    callback?: Callback<number>,
): Promise<number>
Parameters
- dst: RedisKey
- src: RedisKey
- min: string | number | Buffer
- max: string | number | Buffer
- rev: "REV"
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.zrangestore
- Defined in utils/RedisCommander.ts:14514
zrangestore(
    dst: RedisKey,
    src: RedisKey,
    min: string | number | Buffer,
    max: string | number | Buffer,
    rev: "REV",
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    callback?: Callback<number>,
): Promise<number>
Parameters
- dst: RedisKey
- src: RedisKey
- min: string | number | Buffer
- max: string | number | Buffer
- rev: "REV"
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.zrangestore
- Defined in utils/RedisCommander.ts:14522
zrangestore(
    dst: RedisKey,
    src: RedisKey,
    min: string | number | Buffer,
    max: string | number | Buffer,
    byscore: "BYSCORE",
    callback?: Callback<number>,
): Promise<number>
Parameters
- dst: RedisKey
- src: RedisKey
- min: string | number | Buffer
- max: string | number | Buffer
- byscore: "BYSCORE"
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.zrangestore
- Defined in utils/RedisCommander.ts:14533
zrangestore(
    dst: RedisKey,
    src: RedisKey,
    min: string | number | Buffer,
    max: string | number | Buffer,
    byscore: "BYSCORE",
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    callback?: Callback<number>,
): Promise<number>
Parameters
- dst: RedisKey
- src: RedisKey
- min: string | number | Buffer
- max: string | number | Buffer
- byscore: "BYSCORE"
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.zrangestore
- Defined in utils/RedisCommander.ts:14541
zrangestore(
    dst: RedisKey,
    src: RedisKey,
    min: string | number | Buffer,
    max: string | number | Buffer,
    byscore: "BYSCORE",
    rev: "REV",
    callback?: Callback<number>,
): Promise<number>
Parameters
- dst: RedisKey
- src: RedisKey
- min: string | number | Buffer
- max: string | number | Buffer
- byscore: "BYSCORE"
- rev: "REV"
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.zrangestore
- Defined in utils/RedisCommander.ts:14552
zrangestore(
    dst: RedisKey,
    src: RedisKey,
    min: string | number | Buffer,
    max: string | number | Buffer,
    byscore: "BYSCORE",
    rev: "REV",
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    callback?: Callback<number>,
): Promise<number>
Parameters
- dst: RedisKey
- src: RedisKey
- min: string | number | Buffer
- max: string | number | Buffer
- byscore: "BYSCORE"
- rev: "REV"
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.zrangestore
- Defined in utils/RedisCommander.ts:14561
zrangestore(
    dst: RedisKey,
    src: RedisKey,
    min: string | number | Buffer,
    max: string | number | Buffer,
    bylex: "BYLEX",
    callback?: Callback<number>,
): Promise<number>
Parameters
- dst: RedisKey
- src: RedisKey
- min: string | number | Buffer
- max: string | number | Buffer
- bylex: "BYLEX"
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.zrangestore
- Defined in utils/RedisCommander.ts:14573
zrangestore(
    dst: RedisKey,
    src: RedisKey,
    min: string | number | Buffer,
    max: string | number | Buffer,
    bylex: "BYLEX",
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    callback?: Callback<number>,
): Promise<number>
Parameters
- dst: RedisKey
- src: RedisKey
- min: string | number | Buffer
- max: string | number | Buffer
- bylex: "BYLEX"
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.zrangestore
- Defined in utils/RedisCommander.ts:14581
zrangestore(
    dst: RedisKey,
    src: RedisKey,
    min: string | number | Buffer,
    max: string | number | Buffer,
    bylex: "BYLEX",
    rev: "REV",
    callback?: Callback<number>,
): Promise<number>
Parameters
- dst: RedisKey
- src: RedisKey
- min: string | number | Buffer
- max: string | number | Buffer
- bylex: "BYLEX"
- rev: "REV"
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.zrangestore
- Defined in utils/RedisCommander.ts:14592
zrangestore(
    dst: RedisKey,
    src: RedisKey,
    min: string | number | Buffer,
    max: string | number | Buffer,
    bylex: "BYLEX",
    rev: "REV",
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    callback?: Callback<number>,
): Promise<number>
Parameters
- dst: RedisKey
- src: RedisKey
- min: string | number | Buffer
- max: string | number | Buffer
- bylex: "BYLEX"
- rev: "REV"
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.zrangestore
- Defined in utils/RedisCommander.ts:14601

zrank

zrank(
    key: RedisKey,
    member: string | number | Buffer,
    callback?: Callback<number>,
): Promise<number>
Returns the index of a member in a sorted set ordered by ascending scores.
- group: sorted-set
- complexity: O(log(N))
- since: 2.0.0
Parameters
- key: RedisKey
- member: string | number | Buffer
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.zrank
- Defined in utils/RedisCommander.ts:14620
zrank(
    key: RedisKey,
    member: string | number | Buffer,
    withscore: "WITHSCORE",
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- member: string | number | Buffer
- withscore: "WITHSCORE"
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.zrank
- Defined in utils/RedisCommander.ts:14625

zrem

zrem(
    ...args: [
        key: RedisKey,
        ...members: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Removes one or more members from a sorted set. Deletes the sorted set if all members were removed.
- group: sorted-set
- complexity: O(M*log(N)) with N being the number of elements in the sorted set and M the number of elements to be removed.
- since: 1.2.0
Parameters
- ...args: [
      key: RedisKey,
      ...members: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zrem
- Defined in utils/RedisCommander.ts:14638
zrem(
    ...args: [
        key: RedisKey,
        members: (string | number | Buffer)[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      key: RedisKey,
      members: (string | number | Buffer)[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zrem
- Defined in utils/RedisCommander.ts:14645
zrem(
...args: [key: RedisKey, ...members: (string | number | Buffer)[]],
): Promise<number>
Parameters
- ...args: [key: RedisKey, ...members: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.zrem
- Defined in utils/RedisCommander.ts:14652
zrem(
...args: [key: RedisKey, members: (string | number | Buffer)[]],
): Promise<number>
Parameters
- ...args: [key: RedisKey, members: (string | number | Buffer)[]]
Returns Promise<number>
Inherited from Commander.zrem
- Defined in utils/RedisCommander.ts:14655

zremrangebylex

zremrangebylex(
    key: RedisKey,
    min: string | number | Buffer,
    max: string | number | Buffer,
    callback?: Callback<number>,
): Promise<number>
Removes members in a sorted set within a lexicographical range. Deletes the sorted set if all members were removed.
- group: sorted-set
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements removed by the operation.
- since: 2.8.9
Parameters
- key: RedisKey
- min: string | number | Buffer
- max: string | number | Buffer
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.zremrangebylex
- Defined in utils/RedisCommander.ts:14665

zremrangebyrank

zremrangebyrank(
    key: RedisKey,
    start: string | number,
    stop: string | number,
    callback?: Callback<number>,
): Promise<number>
Removes members in a sorted set within a range of indexes. Deletes the sorted set if all members were removed.
- group: sorted-set
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements removed by the operation.
- since: 2.0.0
Parameters
- key: RedisKey
- start: string | number
- stop: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.zremrangebyrank
- Defined in utils/RedisCommander.ts:14678

zremrangebyscore

zremrangebyscore(
    key: RedisKey,
    min: string | number,
    max: string | number,
    callback?: Callback<number>,
): Promise<number>
Removes members in a sorted set within a range of scores. Deletes the sorted set if all members were removed.
- group: sorted-set
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements removed by the operation.
- since: 1.2.0
Parameters
- key: RedisKey
- min: string | number
- max: string | number
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.zremrangebyscore
- Defined in utils/RedisCommander.ts:14691

zrevrange

zrevrange(
    key: RedisKey,
    start: string | number,
    stop: string | number,
    callback?: Callback<string[]>,
): Promise<string[]>
Returns members in a sorted set within a range of indexes in reverse order.
- group: sorted-set
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements returned.
- since: 1.2.0
Parameters
- key: RedisKey
- start: string | number
- stop: string | number
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrevrange
- Defined in utils/RedisCommander.ts:14704
zrevrange(
    key: RedisKey,
    start: string | number,
    stop: string | number,
    withscores: "WITHSCORES",
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- start: string | number
- stop: string | number
- withscores: "WITHSCORES"
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrevrange
- Defined in utils/RedisCommander.ts:14716

zrevrangeBuffer

zrevrangeBuffer(
    key: RedisKey,
    start: string | number,
    stop: string | number,
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- start: string | number
- stop: string | number
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrevrangeBuffer
- Defined in utils/RedisCommander.ts:14710
zrevrangeBuffer(
    key: RedisKey,
    start: string | number,
    stop: string | number,
    withscores: "WITHSCORES",
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- start: string | number
- stop: string | number
- withscores: "WITHSCORES"
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrevrangeBuffer
- Defined in utils/RedisCommander.ts:14723

zrevrangebylex

zrevrangebylex(
    key: RedisKey,
    max: string | number | Buffer,
    min: string | number | Buffer,
    callback?: Callback<string[]>,
): Promise<string[]>
Returns members in a sorted set within a lexicographical range in reverse order.
- group: sorted-set
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements being returned. If M is constant (e.g. always asking for the first 10 elements with LIMIT), you can consider it O(log(N)).
- since: 2.8.9
Parameters
- key: RedisKey
- max: string | number | Buffer
- min: string | number | Buffer
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrevrangebylex
- Defined in utils/RedisCommander.ts:14737
zrevrangebylex(
    key: RedisKey,
    max: string | number | Buffer,
    min: string | number | Buffer,
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- max: string | number | Buffer
- min: string | number | Buffer
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrevrangebylex
- Defined in utils/RedisCommander.ts:14749

zrevrangebylexBuffer

zrevrangebylexBuffer(
    key: RedisKey,
    max: string | number | Buffer,
    min: string | number | Buffer,
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- max: string | number | Buffer
- min: string | number | Buffer
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrevrangebylexBuffer
- Defined in utils/RedisCommander.ts:14743
zrevrangebylexBuffer(
    key: RedisKey,
    max: string | number | Buffer,
    min: string | number | Buffer,
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- max: string | number | Buffer
- min: string | number | Buffer
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrevrangebylexBuffer
- Defined in utils/RedisCommander.ts:14758

zrevrangebyscore

zrevrangebyscore(
    key: RedisKey,
    max: string | number,
    min: string | number,
    callback?: Callback<string[]>,
): Promise<string[]>
Returns members in a sorted set within a range of scores in reverse order.
- group: sorted-set
- complexity: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements being returned. If M is constant (e.g. always asking for the first 10 elements with LIMIT), you can consider it O(log(N)).
- since: 2.2.0
Parameters
- key: RedisKey
- max: string | number
- min: string | number
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrevrangebyscore
- Defined in utils/RedisCommander.ts:14774
zrevrangebyscore(
    key: RedisKey,
    max: string | number,
    min: string | number,
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- max: string | number
- min: string | number
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrevrangebyscore
- Defined in utils/RedisCommander.ts:14786
zrevrangebyscore(
    key: RedisKey,
    max: string | number,
    min: string | number,
    withscores: "WITHSCORES",
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- max: string | number
- min: string | number
- withscores: "WITHSCORES"
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrevrangebyscore
- Defined in utils/RedisCommander.ts:14804
zrevrangebyscore(
    key: RedisKey,
    max: string | number,
    min: string | number,
    withscores: "WITHSCORES",
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    callback?: Callback<string[]>,
): Promise<string[]>
Parameters
- key: RedisKey
- max: string | number
- min: string | number
- withscores: "WITHSCORES"
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- Optionalcallback: Callback<string[]>
Returns Promise<string[]>
Inherited from Commander.zrevrangebyscore
- Defined in utils/RedisCommander.ts:14818

zrevrangebyscoreBuffer

zrevrangebyscoreBuffer(
    key: RedisKey,
    max: string | number,
    min: string | number,
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- max: string | number
- min: string | number
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrevrangebyscoreBuffer
- Defined in utils/RedisCommander.ts:14780
zrevrangebyscoreBuffer(
    key: RedisKey,
    max: string | number,
    min: string | number,
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- max: string | number
- min: string | number
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrevrangebyscoreBuffer
- Defined in utils/RedisCommander.ts:14795
zrevrangebyscoreBuffer(
    key: RedisKey,
    max: string | number,
    min: string | number,
    withscores: "WITHSCORES",
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- max: string | number
- min: string | number
- withscores: "WITHSCORES"
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrevrangebyscoreBuffer
- Defined in utils/RedisCommander.ts:14811
zrevrangebyscoreBuffer(
    key: RedisKey,
    max: string | number,
    min: string | number,
    withscores: "WITHSCORES",
    limitToken: "LIMIT",
    offset: string | number,
    count: string | number,
    callback?: Callback<Buffer[]>,
): Promise<Buffer[]>
Parameters
- key: RedisKey
- max: string | number
- min: string | number
- withscores: "WITHSCORES"
- limitToken: "LIMIT"
- offset: string | number
- count: string | number
- Optionalcallback: Callback<Buffer[]>
Returns Promise<Buffer[]>
Inherited from Commander.zrevrangebyscoreBuffer
- Defined in utils/RedisCommander.ts:14828

zrevrank

zrevrank(
    key: RedisKey,
    member: string | number | Buffer,
    callback?: Callback<number>,
): Promise<number>
Returns the index of a member in a sorted set ordered by descending scores.
- group: sorted-set
- complexity: O(log(N))
- since: 2.0.0
Parameters
- key: RedisKey
- member: string | number | Buffer
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.zrevrank
- Defined in utils/RedisCommander.ts:14845
zrevrank(
    key: RedisKey,
    member: string | number | Buffer,
    withscore: "WITHSCORE",
    callback?: Callback<number>,
): Promise<number>
Parameters
- key: RedisKey
- member: string | number | Buffer
- withscore: "WITHSCORE"
- Optionalcallback: Callback<number>
Returns Promise<number>
Inherited from Commander.zrevrank
- Defined in utils/RedisCommander.ts:14850

zscan

zscan(
    key: RedisKey,
    cursor: string | number,
    callback?: Callback<[cursor: string, elements: string[]]>,
): Promise<[cursor: string, elements: string[]]>
Iterates over members and scores of a sorted set.
- group: sorted-set
- complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection.
- since: 2.8.0
Parameters
- key: RedisKey
- cursor: string | number
- Optionalcallback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Inherited from Commander.zscan
- Defined in utils/RedisCommander.ts:14863
zscan(
    key: RedisKey,
    cursor: string | number,
    noscores: "NOSCORES",
    callback?: Callback<[cursor: string, elements: string[]]>,
): Promise<[cursor: string, elements: string[]]>
Parameters
- key: RedisKey
- cursor: string | number
- noscores: "NOSCORES"
- Optionalcallback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Inherited from Commander.zscan
- Defined in utils/RedisCommander.ts:14873
zscan(
    key: RedisKey,
    cursor: string | number,
    countToken: "COUNT",
    count: string | number,
    callback?: Callback<[cursor: string, elements: string[]]>,
): Promise<[cursor: string, elements: string[]]>
Parameters
- key: RedisKey
- cursor: string | number
- countToken: "COUNT"
- count: string | number
- Optionalcallback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Inherited from Commander.zscan
- Defined in utils/RedisCommander.ts:14885
zscan(
    key: RedisKey,
    cursor: string | number,
    countToken: "COUNT",
    count: string | number,
    noscores: "NOSCORES",
    callback?: Callback<[cursor: string, elements: string[]]>,
): Promise<[cursor: string, elements: string[]]>
Parameters
- key: RedisKey
- cursor: string | number
- countToken: "COUNT"
- count: string | number
- noscores: "NOSCORES"
- Optionalcallback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Inherited from Commander.zscan
- Defined in utils/RedisCommander.ts:14899
zscan(
    key: RedisKey,
    cursor: string | number,
    patternToken: "MATCH",
    pattern: string,
    callback?: Callback<[cursor: string, elements: string[]]>,
): Promise<[cursor: string, elements: string[]]>
Parameters
- key: RedisKey
- cursor: string | number
- patternToken: "MATCH"
- pattern: string
- Optionalcallback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Inherited from Commander.zscan
- Defined in utils/RedisCommander.ts:14915
zscan(
    key: RedisKey,
    cursor: string | number,
    patternToken: "MATCH",
    pattern: string,
    noscores: "NOSCORES",
    callback?: Callback<[cursor: string, elements: string[]]>,
): Promise<[cursor: string, elements: string[]]>
Parameters
- key: RedisKey
- cursor: string | number
- patternToken: "MATCH"
- pattern: string
- noscores: "NOSCORES"
- Optionalcallback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Inherited from Commander.zscan
- Defined in utils/RedisCommander.ts:14929
zscan(
    key: RedisKey,
    cursor: string | number,
    patternToken: "MATCH",
    pattern: string,
    countToken: "COUNT",
    count: string | number,
    callback?: Callback<[cursor: string, elements: string[]]>,
): Promise<[cursor: string, elements: string[]]>
Parameters
- key: RedisKey
- cursor: string | number
- patternToken: "MATCH"
- pattern: string
- countToken: "COUNT"
- count: string | number
- Optionalcallback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Inherited from Commander.zscan
- Defined in utils/RedisCommander.ts:14945
zscan(
    key: RedisKey,
    cursor: string | number,
    patternToken: "MATCH",
    pattern: string,
    countToken: "COUNT",
    count: string | number,
    noscores: "NOSCORES",
    callback?: Callback<[cursor: string, elements: string[]]>,
): Promise<[cursor: string, elements: string[]]>
Parameters
- key: RedisKey
- cursor: string | number
- patternToken: "MATCH"
- pattern: string
- countToken: "COUNT"
- count: string | number
- noscores: "NOSCORES"
- Optionalcallback: Callback<[cursor: string, elements: string[]]>
Returns Promise<[cursor: string, elements: string[]]>
Inherited from Commander.zscan
- Defined in utils/RedisCommander.ts:14963

zscanBuffer

zscanBuffer(
    key: RedisKey,
    cursor: string | number,
    callback?: Callback<[cursor: Buffer, elements: Buffer[]]>,
): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
- key: RedisKey
- cursor: string | number
- Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Inherited from Commander.zscanBuffer
- Defined in utils/RedisCommander.ts:14868
zscanBuffer(
    key: RedisKey,
    cursor: string | number,
    noscores: "NOSCORES",
    callback?: Callback<[cursor: Buffer, elements: Buffer[]]>,
): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
- key: RedisKey
- cursor: string | number
- noscores: "NOSCORES"
- Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Inherited from Commander.zscanBuffer
- Defined in utils/RedisCommander.ts:14879
zscanBuffer(
    key: RedisKey,
    cursor: string | number,
    countToken: "COUNT",
    count: string | number,
    callback?: Callback<[cursor: Buffer, elements: Buffer[]]>,
): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
- key: RedisKey
- cursor: string | number
- countToken: "COUNT"
- count: string | number
- Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Inherited from Commander.zscanBuffer
- Defined in utils/RedisCommander.ts:14892
zscanBuffer(
    key: RedisKey,
    cursor: string | number,
    countToken: "COUNT",
    count: string | number,
    noscores: "NOSCORES",
    callback?: Callback<[cursor: Buffer, elements: Buffer[]]>,
): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
- key: RedisKey
- cursor: string | number
- countToken: "COUNT"
- count: string | number
- noscores: "NOSCORES"
- Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Inherited from Commander.zscanBuffer
- Defined in utils/RedisCommander.ts:14907
zscanBuffer(
    key: RedisKey,
    cursor: string | number,
    patternToken: "MATCH",
    pattern: string,
    callback?: Callback<[cursor: Buffer, elements: Buffer[]]>,
): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
- key: RedisKey
- cursor: string | number
- patternToken: "MATCH"
- pattern: string
- Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Inherited from Commander.zscanBuffer
- Defined in utils/RedisCommander.ts:14922
zscanBuffer(
    key: RedisKey,
    cursor: string | number,
    patternToken: "MATCH",
    pattern: string,
    noscores: "NOSCORES",
    callback?: Callback<[cursor: Buffer, elements: Buffer[]]>,
): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
- key: RedisKey
- cursor: string | number
- patternToken: "MATCH"
- pattern: string
- noscores: "NOSCORES"
- Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Inherited from Commander.zscanBuffer
- Defined in utils/RedisCommander.ts:14937
zscanBuffer(
    key: RedisKey,
    cursor: string | number,
    patternToken: "MATCH",
    pattern: string,
    countToken: "COUNT",
    count: string | number,
    callback?: Callback<[cursor: Buffer, elements: Buffer[]]>,
): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
- key: RedisKey
- cursor: string | number
- patternToken: "MATCH"
- pattern: string
- countToken: "COUNT"
- count: string | number
- Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Inherited from Commander.zscanBuffer
- Defined in utils/RedisCommander.ts:14954
zscanBuffer(
    key: RedisKey,
    cursor: string | number,
    patternToken: "MATCH",
    pattern: string,
    countToken: "COUNT",
    count: string | number,
    noscores: "NOSCORES",
    callback?: Callback<[cursor: Buffer, elements: Buffer[]]>,
): Promise<[cursor: Buffer, elements: Buffer[]]>
Parameters
- key: RedisKey
- cursor: string | number
- patternToken: "MATCH"
- pattern: string
- countToken: "COUNT"
- count: string | number
- noscores: "NOSCORES"
- Optionalcallback: Callback<[cursor: Buffer, elements: Buffer[]]>
Returns Promise<[cursor: Buffer, elements: Buffer[]]>
Inherited from Commander.zscanBuffer
- Defined in utils/RedisCommander.ts:14973

zscanBufferStream

zscanBufferStream(key: string, options?: ScanStreamOptions): ScanStream
Parameters
- key: string
- Optionaloptions: ScanStreamOptions
Returns ScanStream
- Defined in cluster/index.ts:637

zscanStream

zscanStream(key: string, options?: ScanStreamOptions): ScanStream
Parameters
- key: string
- Optionaloptions: ScanStreamOptions
Returns ScanStream
- Defined in cluster/index.ts:633

zscore

zscore(
    key: RedisKey,
    member: string | number | Buffer,
    callback?: Callback<string>,
): Promise<string>
Returns the score of a member in a sorted set.
- group: sorted-set
- complexity: O(1)
- since: 1.2.0
Parameters
- key: RedisKey
- member: string | number | Buffer
- Optionalcallback: Callback<string>
Returns Promise<string>
Inherited from Commander.zscore
- Defined in utils/RedisCommander.ts:14990

zscoreBuffer

zscoreBuffer(
    key: RedisKey,
    member: string | number | Buffer,
    callback?: Callback<Buffer>,
): Promise<Buffer>
Parameters
- key: RedisKey
- member: string | number | Buffer
- Optionalcallback: Callback<Buffer>
Returns Promise<Buffer>
Inherited from Commander.zscoreBuffer
- Defined in utils/RedisCommander.ts:14995

zunion

zunion(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Returns the union of multiple sorted sets.
- group: sorted-set
- complexity: O(N)+O(M*log(M)) with N being the sum of the sizes of the input sorted sets, and M being the number of elements in the resulting sorted set.
- since: 6.2.0
Parameters
- ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15007
zunion(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<string[]>]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15021
zunion(
...args: [numkeys: string | number, ...keys: RedisKey[]],
): Promise<string[]>
Parameters
- ...args: [numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15035
zunion(...args: [numkeys: string | number, keys: RedisKey[]]): Promise<string[]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[]]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15041
zunion(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        withscores: "WITHSCORES",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      withscores: "WITHSCORES",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15047
zunion(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        withscores: "WITHSCORES",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      withscores: "WITHSCORES",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15063
zunion(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        withscores: "WITHSCORES",
    ],
): Promise<string[]>
Parameters
- ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15079
zunion(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        withscores: "WITHSCORES",
    ],
): Promise<string[]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15093
zunion(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15107
zunion(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15125
zunion(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15143
zunion(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
    ],
): Promise<string[]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15159
zunion(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        withscores: "WITHSCORES",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      withscores: "WITHSCORES",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15175
zunion(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        withscores: "WITHSCORES",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      withscores: "WITHSCORES",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15195
zunion(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        withscores: "WITHSCORES",
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      withscores: "WITHSCORES",
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15215
zunion(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        withscores: "WITHSCORES",
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      withscores: "WITHSCORES",
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15233
zunion(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15251
zunion(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15269
zunion(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15287
zunion(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
    ],
): Promise<string[]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15303
zunion(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
        withscores: "WITHSCORES",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
      withscores: "WITHSCORES",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15319
zunion(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
        withscores: "WITHSCORES",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
      withscores: "WITHSCORES",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15339
zunion(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
        withscores: "WITHSCORES",
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
      withscores: "WITHSCORES",
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15359
zunion(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
        withscores: "WITHSCORES",
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
      withscores: "WITHSCORES",
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15377
zunion(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15395
zunion(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15413
zunion(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15431
zunion(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
    ],
): Promise<string[]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15447
zunion(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
        withscores: "WITHSCORES",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
      withscores: "WITHSCORES",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15463
zunion(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
        withscores: "WITHSCORES",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
      withscores: "WITHSCORES",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15483
zunion(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
        withscores: "WITHSCORES",
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
      withscores: "WITHSCORES",
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15503
zunion(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
        withscores: "WITHSCORES",
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
      withscores: "WITHSCORES",
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15521
zunion(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [numkeys: string | number, ...args: RedisValue[], callback: Callback<string[]>]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15539
zunion(
...args: [numkeys: string | number, ...args: RedisValue[]],
): Promise<string[]>
Parameters
- ...args: [numkeys: string | number, ...args: RedisValue[]]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15553
zunion(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        withscores: "WITHSCORES",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      withscores: "WITHSCORES",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15559
zunion(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        withscores: "WITHSCORES",
    ],
): Promise<string[]>
Parameters
- ...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES"]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15575
zunion(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15589
zunion(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        sum: "SUM",
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      sum: "SUM",
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15607
zunion(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        withscores: "WITHSCORES",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      withscores: "WITHSCORES",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15623
zunion(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        withscores: "WITHSCORES",
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      withscores: "WITHSCORES",
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15643
zunion(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        min: "MIN",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      min: "MIN",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15661
zunion(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        min: "MIN",
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      min: "MIN",
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15679
zunion(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        min: "MIN",
        withscores: "WITHSCORES",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      min: "MIN",
      withscores: "WITHSCORES",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15695
zunion(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        min: "MIN",
        withscores: "WITHSCORES",
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      min: "MIN",
      withscores: "WITHSCORES",
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15715
zunion(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        max: "MAX",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      max: "MAX",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15733
zunion(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        max: "MAX",
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      max: "MAX",
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15751
zunion(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        max: "MAX",
        withscores: "WITHSCORES",
        callback: Callback<string[]>,
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      max: "MAX",
      withscores: "WITHSCORES",
      callback: Callback<string[]>,
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15767
zunion(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        max: "MAX",
        withscores: "WITHSCORES",
    ],
): Promise<string[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      max: "MAX",
      withscores: "WITHSCORES",
  ]
Returns Promise<string[]>
Inherited from Commander.zunion
- Defined in utils/RedisCommander.ts:15787

zunionBuffer

zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [numkeys: string | number, ...keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15014
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15028
zunionBuffer(
...args: [numkeys: string | number, ...keys: RedisKey[]],
): Promise<Buffer[]>
Parameters
- ...args: [numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15038
zunionBuffer(
...args: [numkeys: string | number, keys: RedisKey[]],
): Promise<Buffer[]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[]]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15044
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        withscores: "WITHSCORES",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      withscores: "WITHSCORES",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15055
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        withscores: "WITHSCORES",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      withscores: "WITHSCORES",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15071
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        withscores: "WITHSCORES",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [numkeys: string | number, ...keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15086
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        withscores: "WITHSCORES",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[], withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15100
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15116
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15134
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15151
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", sum: "SUM"]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15167
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        withscores: "WITHSCORES",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      withscores: "WITHSCORES",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15185
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        withscores: "WITHSCORES",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      withscores: "WITHSCORES",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15205
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        withscores: "WITHSCORES",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      withscores: "WITHSCORES",
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15224
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        withscores: "WITHSCORES",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      withscores: "WITHSCORES",
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15242
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15260
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15278
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15295
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", min: "MIN"]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15311
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
        withscores: "WITHSCORES",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
      withscores: "WITHSCORES",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15329
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
        withscores: "WITHSCORES",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
      withscores: "WITHSCORES",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15349
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
        withscores: "WITHSCORES",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
      withscores: "WITHSCORES",
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15368
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
        withscores: "WITHSCORES",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
      withscores: "WITHSCORES",
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15386
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15404
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15422
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15439
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [numkeys: string | number, keys: RedisKey[], aggregate: "AGGREGATE", max: "MAX"]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15455
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
        withscores: "WITHSCORES",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
      withscores: "WITHSCORES",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15473
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
        withscores: "WITHSCORES",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
      withscores: "WITHSCORES",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15493
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
        withscores: "WITHSCORES",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
      withscores: "WITHSCORES",
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15512
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
        withscores: "WITHSCORES",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
      withscores: "WITHSCORES",
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15530
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [numkeys: string | number, ...args: RedisValue[], callback: Callback<Buffer[]>]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15546
zunionBuffer(
...args: [numkeys: string | number, ...args: RedisValue[]],
): Promise<Buffer[]>
Parameters
- ...args: [numkeys: string | number, ...args: RedisValue[]]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15556
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        withscores: "WITHSCORES",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      withscores: "WITHSCORES",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15567
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        withscores: "WITHSCORES",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [numkeys: string | number, ...args: RedisValue[], withscores: "WITHSCORES"]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15582
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15598
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        sum: "SUM",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      sum: "SUM",
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15615
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        withscores: "WITHSCORES",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      withscores: "WITHSCORES",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15633
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        withscores: "WITHSCORES",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      withscores: "WITHSCORES",
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15652
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        min: "MIN",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      min: "MIN",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15670
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        min: "MIN",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      min: "MIN",
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15687
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        min: "MIN",
        withscores: "WITHSCORES",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      min: "MIN",
      withscores: "WITHSCORES",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15705
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        min: "MIN",
        withscores: "WITHSCORES",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      min: "MIN",
      withscores: "WITHSCORES",
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15724
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        max: "MAX",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      max: "MAX",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15742
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        max: "MAX",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      max: "MAX",
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15759
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        max: "MAX",
        withscores: "WITHSCORES",
        callback: Callback<Buffer[]>,
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      max: "MAX",
      withscores: "WITHSCORES",
      callback: Callback<Buffer[]>,
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15777
zunionBuffer(
    ...args: [
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        max: "MAX",
        withscores: "WITHSCORES",
    ],
): Promise<Buffer[]>
Parameters
- ...args: [
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      max: "MAX",
      withscores: "WITHSCORES",
  ]
Returns Promise<Buffer[]>
Inherited from Commander.zunionBuffer
- Defined in utils/RedisCommander.ts:15796

zunionstore

zunionstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...keys: RedisKey[],
        callback: Callback<number>,
    ],
): Promise<number>
Stores the union of multiple sorted sets in a key.
- group: sorted-set
- complexity: O(N)+O(M log(M)) with N being the sum of the sizes of the input sorted sets, and M being the number of elements in the resulting sorted set.
- since: 2.0.0
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      ...keys: RedisKey[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zunionstore
- Defined in utils/RedisCommander.ts:15812
zunionstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        keys: RedisKey[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      keys: RedisKey[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zunionstore
- Defined in utils/RedisCommander.ts:15820
zunionstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...keys: RedisKey[],
    ],
): Promise<number>
Parameters
- ...args: [destination: RedisKey, numkeys: string | number, ...keys: RedisKey[]]
Returns Promise<number>
Inherited from Commander.zunionstore
- Defined in utils/RedisCommander.ts:15828
zunionstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        keys: RedisKey[],
    ],
): Promise<number>
Parameters
- ...args: [destination: RedisKey, numkeys: string | number, keys: RedisKey[]]
Returns Promise<number>
Inherited from Commander.zunionstore
- Defined in utils/RedisCommander.ts:15835
zunionstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zunionstore
- Defined in utils/RedisCommander.ts:15838
zunionstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zunionstore
- Defined in utils/RedisCommander.ts:15848
zunionstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
  ]
Returns Promise<number>
Inherited from Commander.zunionstore
- Defined in utils/RedisCommander.ts:15858
zunionstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        sum: "SUM",
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      sum: "SUM",
  ]
Returns Promise<number>
Inherited from Commander.zunionstore
- Defined in utils/RedisCommander.ts:15867
zunionstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zunionstore
- Defined in utils/RedisCommander.ts:15876
zunionstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zunionstore
- Defined in utils/RedisCommander.ts:15886
zunionstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
  ]
Returns Promise<number>
Inherited from Commander.zunionstore
- Defined in utils/RedisCommander.ts:15896
zunionstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        min: "MIN",
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      min: "MIN",
  ]
Returns Promise<number>
Inherited from Commander.zunionstore
- Defined in utils/RedisCommander.ts:15905
zunionstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zunionstore
- Defined in utils/RedisCommander.ts:15914
zunionstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zunionstore
- Defined in utils/RedisCommander.ts:15924
zunionstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      ...keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
  ]
Returns Promise<number>
Inherited from Commander.zunionstore
- Defined in utils/RedisCommander.ts:15934
zunionstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        keys: RedisKey[],
        aggregate: "AGGREGATE",
        max: "MAX",
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      keys: RedisKey[],
      aggregate: "AGGREGATE",
      max: "MAX",
  ]
Returns Promise<number>
Inherited from Commander.zunionstore
- Defined in utils/RedisCommander.ts:15943
zunionstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...args: RedisValue[],
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      ...args: RedisValue[],
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zunionstore
- Defined in utils/RedisCommander.ts:15952
zunionstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...args: RedisValue[],
    ],
): Promise<number>
Parameters
- ...args: [destination: RedisKey, numkeys: string | number, ...args: RedisValue[]]
Returns Promise<number>
Inherited from Commander.zunionstore
- Defined in utils/RedisCommander.ts:15960
zunionstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        sum: "SUM",
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      sum: "SUM",
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zunionstore
- Defined in utils/RedisCommander.ts:15967
zunionstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        sum: "SUM",
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      sum: "SUM",
  ]
Returns Promise<number>
Inherited from Commander.zunionstore
- Defined in utils/RedisCommander.ts:15977
zunionstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        min: "MIN",
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      min: "MIN",
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zunionstore
- Defined in utils/RedisCommander.ts:15986
zunionstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        min: "MIN",
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      min: "MIN",
  ]
Returns Promise<number>
Inherited from Commander.zunionstore
- Defined in utils/RedisCommander.ts:15996
zunionstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        max: "MAX",
        callback: Callback<number>,
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      max: "MAX",
      callback: Callback<number>,
  ]
Returns Promise<number>
Inherited from Commander.zunionstore
- Defined in utils/RedisCommander.ts:16005
zunionstore(
    ...args: [
        destination: RedisKey,
        numkeys: string
        | number,
        ...args: RedisValue[],
        aggregate: "AGGREGATE",
        max: "MAX",
    ],
): Promise<number>
Parameters
- ...args: [
      destination: RedisKey,
      numkeys: string
      | number,
      ...args: RedisValue[],
      aggregate: "AGGREGATE",
      max: "MAX",
  ]
Returns Promise<number>
Inherited from Commander.zunionstore
- Defined in utils/RedisCommander.ts:16015

Class Cluster

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Cluster

Properties

options

slots

status

Accessors

autoPipelineQueueSize

Returns number

Methods

acl

Parameters

Returns Promise<unknown>

Parameters

Returns Promise<unknown>

Parameters

Returns Promise<number>

Parameters

Returns Promise<number>

Parameters

Returns Promise<string>

Parameters

Returns Promise<string>

Parameters

Returns Promise<string>

Parameters

Returns Promise<string>

Parameters

Returns Promise<string>

Parameters

Returns Promise<string[]>

Parameters

Returns Promise<unknown>

Parameters

Returns Promise<string[]>

Parameters

Returns Promise<"OK">

Parameters

Returns Promise<unknown>

Parameters

Returns Promise<unknown>

Parameters

Returns Promise<unknown>

Parameters

Returns Promise<"OK">

Parameters

Returns Promise<"OK">

Parameters

Returns Promise<"OK">

Parameters

Returns Promise<"OK">

Parameters

Returns Promise<string[]>

Parameters

Returns Promise<string>

aclBuffer

Parameters

Returns Promise<Buffer>

Parameters

Returns Promise<Buffer>

Parameters

Returns Promise<Buffer>

Parameters

Returns Promise<Buffer>

Parameters

Returns Promise<Buffer>

Parameters

Returns Promise<Buffer[]>

Parameters

Returns Promise<Buffer[]>

Parameters